GetBusy REST API
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
GetBusy is a new and better way to work with your team and clients.Team chat meets client communication, win more business with modern relationship management, work prioritization, task delegation, and secure file sharing.
The GetBusy API allows you to access the same functionality as used by our web and mobile apps.
Base URL:
Current API version: v1
Authentication
The GetBusy REST API uses OpenID Connect (OIDC) protocol to authorize calls. OIDC is an open standard that many companies use to provide secure access to protected resources.
You can read more about OIDC here. To start you'll need to contact us to request a client ID and client secret. The exact grant type will depend on the type of client you are building.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Connections
Retrieves a User Profile for a Connection
GET /api/v1/contacts/person/{contactGuid}/profile
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| contactGuid | path | string(uuid) | true | The Connection uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"first_name",
"last_name",
"email_address",
"account_name",
"account_description",
"about",
"initials",
"avatar",
"bot_version",
"team_role"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
},
"about": {
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"bot_version": {
"format": "int32",
"type": "integer"
},
"team_role": {
"type": "string"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_UserProfileResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Retrieves the onboarding bot version assigned to the logged in user.
GET /api/v1/onboardingbot/version
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"version"
],
"type": "object",
"properties": {
"version": {
"format": "int32",
"type": "integer"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_VersionResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Get Connections for user
GET /api/v1/contacts/person
Returns the full list of Connections for the current user
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"first_name",
"last_name",
"email_address",
"contact_guid",
"display_name",
"user_guid",
"unread_count",
"active_count",
"total_count_in",
"total_count_out",
"last_activity",
"initials",
"tags",
"props",
"is_team"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"contact_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"display_name": {
"type": "string"
},
"user_guid": {
"type": "string"
},
"unread_count": {
"format": "int32",
"type": "integer"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"total_count_in": {
"format": "int32",
"type": "integer"
},
"total_count_out": {
"format": "int32",
"type": "integer"
},
"last_activity": {
"format": "date-time",
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"is_bot": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"is_team": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Connections Retrieved | IServiceResponse_PersonContactResponseArray_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Creates a new Connection
POST /api/v1/contacts/person
Body parameter
{
"required": [
"first_name",
"last_name",
"email_address"
],
"type": "object",
"properties": {
"first_name": {
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"last_name": {
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"email_address": {
"type": "string"
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreatePersonContactRequest | true | The Connection |
Example responses
201 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"first_name",
"last_name",
"email_address",
"contact_guid",
"display_name",
"user_guid",
"unread_count",
"active_count",
"total_count_in",
"total_count_out",
"last_activity",
"initials",
"tags",
"props",
"is_team"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"contact_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"display_name": {
"type": "string"
},
"user_guid": {
"type": "string"
},
"unread_count": {
"format": "int32",
"type": "integer"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"total_count_in": {
"format": "int32",
"type": "integer"
},
"total_count_out": {
"format": "int32",
"type": "integer"
},
"last_activity": {
"format": "date-time",
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"is_bot": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"is_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Connection created | IServiceResponse_PersonContactResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Retrieves a specific Connection by Connection uuid
GET /api/v1/contacts/person/{contactGuid}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| contactGuid | path | string(uuid) | true | The contact uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"first_name",
"last_name",
"email_address",
"contact_guid",
"display_name",
"user_guid",
"unread_count",
"active_count",
"total_count_in",
"total_count_out",
"last_activity",
"initials",
"tags",
"props",
"is_team"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"contact_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"display_name": {
"type": "string"
},
"user_guid": {
"type": "string"
},
"unread_count": {
"format": "int32",
"type": "integer"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"total_count_in": {
"format": "int32",
"type": "integer"
},
"total_count_out": {
"format": "int32",
"type": "integer"
},
"last_activity": {
"format": "date-time",
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"is_bot": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"is_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Contact Retrieved | IServiceResponse_PersonContactResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Documents
Upload a new document.
POST /api/v1/documents
Example responses
201 Response
{
"required": [
"auth",
"channel_data"
],
"type": "object",
"properties": {
"auth": {
"type": "string",
"readOnly": true
},
"channel_data": {
"type": "string",
"readOnly": true
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | IAuthenticationData |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Unauthorized | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Download a document
GET /api/v1/documents/{documentId}
Please note, this endpoint is not authorized but requires valid download ticket.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| documentId | path | string(uuid) | true | The document uuid |
| ticket | query | string | true | A download ticket |
| inline | query | boolean | false | Use inline content-disposition header - otherwise download (defaults to false) |
Example responses
200 Response
{
"required": [
"CanRead",
"CanSeek",
"CanTimeout",
"CanWrite",
"Length",
"Position",
"ReadTimeout",
"WriteTimeout"
],
"type": "object",
"properties": {
"__identity": {
"type": "object"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Stream |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Unauthorized | None |
| 500 | Internal Server Error | Internal Server Error | None |
Localization
Get localization resource
GET /api/v1/localization
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"localizations",
"language",
"culture"
],
"type": "object",
"properties": {
"localizations": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"language": {
"type": "string"
},
"culture": {
"type": "string"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_LocalizationResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
Messages
Updates account profile
PUT /api/v1/accounts/profile
Body parameter
{
"required": [
"account_name",
"account_description"
],
"type": "object",
"properties": {
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountProfileRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"account_guid",
"account_name",
"account_description"
],
"type": "object",
"properties": {
"account_guid": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_AccountProfileResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Retrieves statistics for filters
GET /api/v1/messages/filters
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"type",
"active_count",
"visible_count",
"has_data"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"MyTasks",
"UpcomingEvents",
"MyQuotes",
"Catchup"
],
"type": "string"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"visible_count": {
"format": "int32",
"type": "integer"
},
"has_data": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_List_FilterResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Returns order of items in MyTasks
GET /api/v1/messages/filters/order/{viewId}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| viewId | path | string | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"view_id",
"groups"
],
"type": "object",
"properties": {
"view_id": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"required": [
"ordered_items"
],
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"ordered_items": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_OrderResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Update mytasks order
PUT /api/v1/messages/filters/order
Body parameter
{
"required": [
"view_id",
"ordered_items"
],
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"view_id": {
"type": "string"
},
"ordered_items": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OrderRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"view_id",
"groups"
],
"type": "object",
"properties": {
"view_id": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"required": [
"ordered_items"
],
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"ordered_items": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_OrderResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Get a specific thread by the thread uuid
GET /api/v1/messages/{messageGuid}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptResponse_ |
| 201 | Created | Message Created | IServiceResponse_PromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Attachments - retrieve document upload restrictions
GET /api/v1/messages/upload/limits
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"max_size",
"allowed_extensions",
"max_attachments"
],
"type": "object",
"properties": {
"max_size": {
"format": "int32",
"type": "integer"
},
"allowed_extensions": {
"type": "array",
"items": {
"type": "string"
}
},
"max_attachments": {
"format": "int32",
"type": "integer"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_UploadLimitsResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Attachments - retrieve a download ticket.
GET /api/v1/messages/{messageGuid}/download/{attachmentGuid}
A download ticket permits the holder to download a document using the document/download endpoint.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
| attachmentGuid | path | string(uuid) | true | The attachment uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "string",
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_String_ |
| 201 | Created | Message Created | IServiceResponse_String_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Threads - retrieve threads for a Connection
GET /api/v1/messages/contact/{contactUserGuid}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| contactUserGuid | path | string(uuid) | true | The Connection's user uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptResponseArray_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Threads - retrieve threads for a Connection including team shared messages
GET /api/v1/messages/contact/{contactUserGuid}/team
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| contactUserGuid | path | string(uuid) | true | The Connection's user uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptResponseArray_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Filter - Retrieve all to-do's for the current user
GET /api/v1/messages/filters/mytasks
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptResponseArray_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Filter - Retrieve open (non-cancelled) price threads created by the logged-in user
GET /api/v1/messages/filters/myquotes
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptResponseArray_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Filter - Retrieve all agreed events for the logged-in user
GET /api/v1/messages/filters/upcomingevents
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptResponseArray_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Filter - Retrieve all threads that are currently in 'catch-up'
GET /api/v1/messages/filters/catchup
The 'catch-up' filter returns all threads that require some attention (e.g. unread comment, outstanding decision and so on)
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"prompts",
"summary"
],
"type": "object",
"properties": {
"prompts": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
}
},
"summary": {
"type": "array",
"items": {
"required": [
"reason",
"count"
],
"type": "object",
"properties": {
"reason": {
"enum": [
"None",
"Unread",
"Questioned",
"UserComment",
"Answered",
"Nudged",
"ReminderSent",
"ChatCreated",
"TaskProposed",
"QuoteProposed",
"EventProposed",
"TaskAcknowledged",
"TaskSuggestedComplete",
"TaskCompleted",
"TaskReopened",
"QuoteAccepted",
"QuoteDeclined",
"EventAccepted",
"EventDeclined",
"EventUpdated",
"QuoteUpdated",
"TaskCancelled",
"TaskUncancelled",
"EventCancelled",
"EventUncancelled",
"QuoteCancelled",
"QuoteUncancelled",
"TaskPaused",
"TaskUnpaused",
"ChatArchived",
"QuoteArchived",
"ChatUnarchived",
"QuoteUnarchived",
"SeenByAssignee"
],
"type": "string"
},
"count": {
"format": "int32",
"type": "integer"
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CatchupResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Types - Retrieve thread types and their options
GET /api/v1/messages/types
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"type",
"assign",
"title",
"comment",
"amount",
"slot_picker",
"seed",
"attachments",
"multiple_participants",
"allow_personal",
"allow_unassigned",
"toggle_team_visibility"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"assign": {
"enum": [
"None",
"Recipient",
"Sender",
"Selectable"
],
"type": "string"
},
"title": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"comment": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"amount": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"slot_picker": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"seed": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"attachments": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"multiple_participants": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"allow_personal": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"allow_unassigned": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"toggle_team_visibility": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptTypeResponseArray_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Prices - Retrieve a list of supported currencies
GET /api/v1/messages/quote/currencies
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"code",
"symbol"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CurrencyResponseArray_ |
This endpoint requires authentication.
Quick replies - Retrieve a map of quick replies
GET /api/v1/messages/quickresponses
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"type",
"items"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"enum": [
"None",
"Thanks",
"ThatsGreat",
"ThumbsUpEmoji",
"SeeYouThen",
"WillBeInTouch",
"Nevermind",
"ThanksForConsidering",
"WontForget",
"WaitingOnSomething",
"LetMeThinkAboutIt",
"IllCheckMyDiary",
"ThanksIllDecideAsap",
"GiveMe48Hours",
"GoodToKnow",
"FaceScreamingInFearEmoji",
"ElephantEmoji",
"FlushedFaceEmoji",
"GotIt",
"WillDo",
"SorryNotMe",
"IllHaveAThink",
"ThinkingFaceEmoji"
],
"type": "string"
}
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_QuickResponseDescriptorArray_ |
This endpoint requires authentication.
Attachment - Retrieve download options
GET /api/v1/messages/download/options
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"inline_extensions"
],
"type": "object",
"properties": {
"inline_extensions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_DownloadOptionsResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Create a new comment
POST /api/v1/messages/{messageGuid}/comment
Creates new comment on an existing thread
Body parameter
{
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
| body | body | CommentRequest | true | The comment |
Example responses
201 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Gets the supported views.
GET /api/v1/views
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"view_id": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"filter_by": {
"type": "array",
"items": {
"type": "array",
"items": {
"required": [
"tag",
"exclude"
],
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"exclude": {
"type": "boolean"
}
}
}
}
},
"order_by": {
"type": "array",
"items": {
"required": [
"prop",
"desc"
],
"type": "object",
"properties": {
"prop": {
"type": "string"
},
"desc": {
"type": "boolean"
}
}
}
},
"groups": {
"type": "array",
"items": "[Circular]"
},
"limit": {
"format": "int32",
"type": "integer"
}
}
}
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_ViewDescriptorArray_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Events - Retrieve timeslots for event scheduling
GET /api/v1/messages/event/slots
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer(int32) | true | Offset from UTC in minutes |
| start | query | string(date-time) | true | Start date |
| days | query | integer(int32) | true | Number of days to return |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"label",
"from",
"to",
"available",
"start_times"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"available": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_List_ScheduleSlot_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Events - Retrieve timeslots in tabular format (header and rows)
GET /api/v1/messages/event/slots/table
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer(int32) | true | Offset from UTC in minutes |
| start | query | string(date-time) | true | Start Date |
| days | query | integer(int32) | true | Number of Days to return |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"header",
"rows"
],
"type": "object",
"properties": {
"header": {
"type": "array",
"items": {
"format": "date-time",
"type": "string"
}
},
"rows": {
"type": "array",
"items": {
"required": [
"label",
"data"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"required": [
"label",
"from",
"to",
"available",
"start_times"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"available": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_ScheduleTableResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
To-do - Create a new 'to-do' thread
POST /api/v1/messages/task
Body parameter
{
"required": [
"type",
"title",
"recipient",
"participants",
"comment",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"comment": {
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | TaskPromptRequest | true | The thread details |
Example responses
201 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"acknowledge",
"is_assignee",
"complete",
"suggest_complete",
"seen",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"acknowledge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"complete": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"suggest_complete": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"seen": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | IServiceResponse_TaskPromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
To-do - Create a new 'to-do' thread from a 'seed' comment.
POST /api/v1/messages/task/seed
Body parameter
{
"required": [
"comment_id",
"title",
"Type",
"participants",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"Type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SeedRequest | true | The seed comment |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"acknowledge",
"is_assignee",
"complete",
"suggest_complete",
"seen",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"acknowledge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"complete": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"suggest_complete": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"seen": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_TaskPromptResponse_ |
| 201 | Created | Created | IServiceResponse_TaskPromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Note - Create a new 'note' thread
POST /api/v1/messages/chat
Body parameter
{
"required": [
"type",
"title",
"recipient",
"participants",
"comment",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"comment": {
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ChatPromptRequest | true | The thread to be created |
Example responses
201 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"is_nudgeable",
"assigned",
"is_assignee",
"is_self_assigned",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_nudgeable": {
"type": "boolean"
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | IServiceResponse_ChatPromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Price - Create a new 'price' thread
POST /api/v1/messages/quote
Body parameter
{
"required": [
"type",
"assigned",
"amount",
"currency_code",
"title",
"recipient",
"participants",
"comment",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"assigned": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000"
},
"amount": {
"format": "double",
"type": "number"
},
"currency_code": {
"type": "string"
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"comment": {
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | QuotePromptRequest | true | The thread to be created |
Example responses
201 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"is_assignee",
"is_self_assigned",
"amount",
"currency",
"is_priceable",
"decide",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"amount": {
"format": "double",
"type": "number"
},
"currency": {
"required": [
"code",
"symbol"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"is_priceable": {
"type": "boolean"
},
"decide": {
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | IServiceResponse_QuotePromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Event - Create a new 'event' thread
POST /api/v1/messages/event
Body parameter
{
"required": [
"type",
"assigned",
"slots",
"title",
"recipient",
"participants",
"comment",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"assigned": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000"
},
"slots": {
"type": "array",
"items": {
"required": [
"from",
"to",
"offset",
"specific_time_selected"
],
"type": "object",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"specific_time_selected": {
"type": "boolean"
}
}
}
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"comment": {
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | EventPromptRequest | true | The thread to be created |
Example responses
201 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"assigned",
"is_assignee",
"is_self_assigned",
"decide",
"select",
"slots",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"decide": {
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"select": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"selected_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"slots": {
"type": "array",
"items": {
"required": [
"slot_guid",
"from",
"to",
"offset",
"available",
"specific_time_selected",
"start_times"
],
"type": "object",
"properties": {
"slot_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"available": {
"type": "boolean"
},
"specific_time_selected": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | IServiceResponse_EventPromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Change times on an Event
PUT /api/v1/messages/event/{messageGuid}/slots
Edit the suggested time slots on an existing 'event' thread
Body parameter
{
"type": "array",
"items": {
"required": [
"from",
"to",
"offset",
"specific_time_selected"
],
"type": "object",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"specific_time_selected": {
"type": "boolean"
}
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
| body | body | array[object] | true | The new time slots |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"assigned",
"is_assignee",
"is_self_assigned",
"decide",
"select",
"slots",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"decide": {
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"select": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"selected_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"slots": {
"type": "array",
"items": {
"required": [
"slot_guid",
"from",
"to",
"offset",
"available",
"specific_time_selected",
"start_times"
],
"type": "object",
"properties": {
"slot_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"available": {
"type": "boolean"
},
"specific_time_selected": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_EventPromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Change a price
PUT /api/v1/messages/quote/{messageGuid}/amount
Edit the price of an existing 'price' thread
Body parameter
{
"required": [
"amount",
"currency_code"
],
"type": "object",
"properties": {
"amount": {
"format": "double",
"type": "number"
},
"currency_code": {
"type": "string"
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
| body | body | AmountRequest | true | The new amount |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"is_assignee",
"is_self_assigned",
"amount",
"currency",
"is_priceable",
"decide",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"amount": {
"format": "double",
"type": "number"
},
"currency": {
"required": [
"code",
"symbol"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"is_priceable": {
"type": "boolean"
},
"decide": {
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_QuotePromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Read comments on a thread
PUT /api/v1/messages/{messageGuid}/read
Set the 'read' property on a thread to indicate that the current user has read any unread comments
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"id",
"prompt_id",
"prompt_type",
"read",
"reader",
"meta",
"comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"prompt_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"prompt_type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"read": {
"format": "date-time",
"type": "string"
},
"reader": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": "[Circular]"
}
}
}
},
"comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_ReadResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Accept a thread
PUT /api/v1/messages/{messageGuid}/accept
For threads that have a decision (e.g. Prices) - marks the decision as 'Accepted'
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Decline a thread
PUT /api/v1/messages/{messageGuid}/decline
For threads that have a decision (e.g. Prices) - marks the decision as 'Declined'
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
No suitable timeslots for Events
POST /api/v1/messages/event/{messageGuid}/slots/selection/none
Mark none of the suggested times as suitable
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Select a timeslot on an Event
POST /api/v1/messages/event/{messageGuid}/slots/selection/{slotGuid}
Selects one of the suggested timeslots for an event thread.
Body parameter
{
"format": "date-time",
"type": "string"
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
| slotGuid | path | string(uuid) | true | The specific timeslot uuid. |
| body | body | string(date-time) | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Archive a thread
PUT /api/v1/messages/{messageGuid}/archive
Mark a thread as 'archived'
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Unarchive a thread
PUT /api/v1/messages/{messageGuid}/unarchive
Remove 'archived' property from a thread
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Cancel a thread
PUT /api/v1/messages/{messageGuid}/cancel
Mark a thread as 'cancelled' (for threads that support cancellation Prices, Events, and To-dos)
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Uncancel a thread
PUT /api/v1/messages/{messageGuid}/uncancel
Remove the cancel property in a thread
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Pause to-do
PUT /api/v1/messages/{messageGuid}/pause
Allows the user to mark a thread (where supported - current to-do's) (i.e. on hold - no further input on a to-do until resumed) until the date and time specified in the 'until' parameter. After which the to-do will be automatically resumed.
Body parameter
{
"format": "date-time",
"type": "string"
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid |
| body | body | string(date-time) | true | The date / time to paused the thread until. |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Unpause - Resumes a previously paused thread
PUT /api/v1/messages/{messageGuid}/unpause
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The thread uuid. |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Add attachment - Attach a document to a thread.
POST /api/v1/messages/{promptGuid}/attach
Body parameter
{
"required": [
"documents"
],
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| promptGuid | path | string(uuid) | true | The prompt unique identifier. |
| body | body | AttachmentRequest | true | The attachment request. |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_CommentResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Assign a thread
PUT /api/v1/messages/{messageGuid}/assign
Assign a user to a thread.
Body parameter
{
"type": "object",
"properties": {
"assignee": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The prompt unique identifier. |
| body | body | AssignmentRequest | true | Contains the unique identifier of the participant to assign to. |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Update prompt visibility
PUT /api/v1/messages/{messageGuid}/visibility
Update team visibility on prompt.
Body parameter
{
"required": [
"team_visibility"
],
"type": "object",
"properties": {
"team_visibility": {
"type": "boolean"
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| messageGuid | path | string(uuid) | true | The prompt unique identifier. |
| body | body | PromptVisibilityUpdateRequest | true | Contains the new boolean value of team visibility. |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_PromptResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Users
Get Profile
GET /api/v1/user/profile
Retrieve the Profile for the current user.
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"first_name",
"last_name",
"email_address",
"account_name",
"account_description",
"about",
"initials",
"avatar",
"bot_version",
"team_role"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
},
"about": {
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"bot_version": {
"format": "int32",
"type": "integer"
},
"team_role": {
"type": "string"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | IServiceResponse_UserProfileResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Create or update Profile
POST /api/v1/user/profile
Create a new, or update an existing, profile for the current user. A user's profile is visible to all Connections.
Body parameter
{
"required": [
"account_name",
"about",
"team_role"
],
"type": "object",
"properties": {
"account_name": {
"type": "string"
},
"about": {
"type": "string"
},
"team_role": {
"type": "string"
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserProfileRequest | true | The Profile to create / update |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"first_name",
"last_name",
"email_address",
"account_name",
"account_description",
"about",
"initials",
"avatar",
"bot_version",
"team_role"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
},
"about": {
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"bot_version": {
"format": "int32",
"type": "integer"
},
"team_role": {
"type": "string"
}
}
},
"error": {
"required": [
"http_status_code",
"error_code"
],
"type": "object",
"properties": {
"http_status_code": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string"
},
"error_code": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Profile updated | ILegacyServiceResponse_UserProfileResponse_ErrorResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Get Team information
GET /api/v1/user/team
Get Team information including members details
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"user_guid",
"account_guid"
],
"type": "object",
"properties": {
"user_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"account_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Team information | IServiceResponse_TeamInviteResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Invite to Team
POST /api/v1/user/team/invite
Invite user to a specific team.
Body parameter
{
"required": [
"email_address"
],
"type": "object",
"properties": {
"email_address": {
"type": "string"
}
}
}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | TeamInviteRequest | true | Team invite request |
Example responses
200 Response
{
"type": "object",
"properties": {
"result": {
"required": [
"user_id",
"account_id",
"email_address",
"first_name",
"last_name",
"avatar",
"invitation_pending",
"roles"
],
"type": "object",
"properties": {
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"account_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"email_address": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"invitation_pending": {
"type": "boolean"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Invite to team | IServiceResponse_TeamMemberResponse_ |
| 400 | Bad Request | Bad Request | None |
| 404 | Not Found | Not Found | None |
| 500 | Internal Server Error | Internal Server Error | None |
This endpoint requires authentication.
Schemas
UserProfileResponse
{
"required": [
"first_name",
"last_name",
"email_address",
"account_name",
"account_description",
"about",
"initials",
"avatar",
"bot_version",
"team_role"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
},
"about": {
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"bot_version": {
"format": "int32",
"type": "integer"
},
"team_role": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| first_name | string | true | none | none |
| last_name | string | true | none | none |
| email_address | string | true | none | none |
| account_name | string | true | none | none |
| account_description | string | true | none | none |
| about | string | true | none | none |
| initials | string | true | none | none |
| avatar | Avatar | true | none | none |
| bot_version | integer(int32) | true | none | none |
| team_role | string | true | none | none |
IServiceError
{
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| StatusCode | string | true | read-only | none |
| ErrorCode | string | true | read-only | none |
| Messages | [string] | true | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| StatusCode | Continue |
| StatusCode | SwitchingProtocols |
| StatusCode | OK |
| StatusCode | Created |
| StatusCode | Accepted |
| StatusCode | NonAuthoritativeInformation |
| StatusCode | NoContent |
| StatusCode | ResetContent |
| StatusCode | PartialContent |
| StatusCode | MultipleChoices |
| StatusCode | Ambiguous |
| StatusCode | MovedPermanently |
| StatusCode | Moved |
| StatusCode | Found |
| StatusCode | Redirect |
| StatusCode | SeeOther |
| StatusCode | RedirectMethod |
| StatusCode | NotModified |
| StatusCode | UseProxy |
| StatusCode | Unused |
| StatusCode | TemporaryRedirect |
| StatusCode | RedirectKeepVerb |
| StatusCode | BadRequest |
| StatusCode | Unauthorized |
| StatusCode | PaymentRequired |
| StatusCode | Forbidden |
| StatusCode | NotFound |
| StatusCode | MethodNotAllowed |
| StatusCode | NotAcceptable |
| StatusCode | ProxyAuthenticationRequired |
| StatusCode | RequestTimeout |
| StatusCode | Conflict |
| StatusCode | Gone |
| StatusCode | LengthRequired |
| StatusCode | PreconditionFailed |
| StatusCode | RequestEntityTooLarge |
| StatusCode | RequestUriTooLong |
| StatusCode | UnsupportedMediaType |
| StatusCode | RequestedRangeNotSatisfiable |
| StatusCode | ExpectationFailed |
| StatusCode | UpgradeRequired |
| StatusCode | InternalServerError |
| StatusCode | NotImplemented |
| StatusCode | BadGateway |
| StatusCode | ServiceUnavailable |
| StatusCode | GatewayTimeout |
| StatusCode | HttpVersionNotSupported |
Avatar
{
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| 24 | string | true | none | none |
| 40 | string | true | none | none |
| 56 | string | true | none | none |
| 60 | string | true | none | none |
| 80 | string | true | none | none |
| 120 | string | true | none | none |
| default | string | true | none | none |
VersionResponse
{
"required": [
"version"
],
"type": "object",
"properties": {
"version": {
"format": "int32",
"type": "integer"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| version | integer(int32) | true | none | none |
CreatePersonContactRequest
{
"required": [
"first_name",
"last_name",
"email_address"
],
"type": "object",
"properties": {
"first_name": {
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"last_name": {
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"email_address": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| first_name | string | true | none | none |
| last_name | string | true | none | none |
| email_address | string | true | none | none |
PersonContactResponse
{
"required": [
"first_name",
"last_name",
"email_address",
"contact_guid",
"display_name",
"user_guid",
"unread_count",
"active_count",
"total_count_in",
"total_count_out",
"last_activity",
"initials",
"tags",
"props",
"is_team"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"contact_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"display_name": {
"type": "string"
},
"user_guid": {
"type": "string"
},
"unread_count": {
"format": "int32",
"type": "integer"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"total_count_in": {
"format": "int32",
"type": "integer"
},
"total_count_out": {
"format": "int32",
"type": "integer"
},
"last_activity": {
"format": "date-time",
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"is_bot": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"is_team": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| first_name | string | true | none | none |
| last_name | string | true | none | none |
| email_address | string | true | none | none |
| contact_guid | string(uuid) | true | none | none |
| display_name | string | true | none | none |
| user_guid | string | true | none | none |
| unread_count | integer(int32) | true | none | none |
| active_count | integer(int32) | true | none | none |
| total_count_in | integer(int32) | true | none | none |
| total_count_out | integer(int32) | true | none | none |
| last_activity | string(date-time) | true | none | none |
| initials | string | true | none | none |
| avatar | Avatar | false | none | none |
| is_bot | boolean | false | none | none |
| tags | [string] | true | none | none |
| props | object | true | none | none |
| » additionalProperties | string | false | none | none |
| is_team | boolean | true | none | none |
DocumentResponse
{
"required": [
"document_id",
"file_name",
"mime_type",
"length",
"uri"
],
"type": "object",
"properties": {
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int64",
"type": "integer"
},
"uri": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| document_id | string(uuid) | true | none | none |
| file_name | string | true | none | none |
| mime_type | string | true | none | none |
| length | integer(int64) | true | none | none |
| uri | string | true | none | none |
IAuthenticationData
{
"required": [
"auth",
"channel_data"
],
"type": "object",
"properties": {
"auth": {
"type": "string",
"readOnly": true
},
"channel_data": {
"type": "string",
"readOnly": true
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| auth | string | true | read-only | none |
| channel_data | string | true | read-only | none |
Stream
{
"required": [
"CanRead",
"CanSeek",
"CanTimeout",
"CanWrite",
"Length",
"Position",
"ReadTimeout",
"WriteTimeout"
],
"type": "object",
"properties": {
"__identity": {
"type": "object"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| __identity | object | false | none | none |
LocalizationResponse
{
"required": [
"localizations",
"language",
"culture"
],
"type": "object",
"properties": {
"localizations": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"language": {
"type": "string"
},
"culture": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localizations | object | true | none | none |
| » additionalProperties | string | false | none | none |
| language | string | true | none | none |
| culture | string | true | none | none |
AccountProfileRequest
{
"required": [
"account_name",
"account_description"
],
"type": "object",
"properties": {
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| account_name | string | true | none | none |
| account_description | string | true | none | none |
AccountProfileResponse
{
"required": [
"account_guid",
"account_name",
"account_description"
],
"type": "object",
"properties": {
"account_guid": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| account_guid | string | true | none | none |
| account_name | string | true | none | none |
| account_description | string | true | none | none |
FilterResponse
{
"required": [
"type",
"active_count",
"visible_count",
"has_data"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"MyTasks",
"UpcomingEvents",
"MyQuotes",
"Catchup"
],
"type": "string"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"visible_count": {
"format": "int32",
"type": "integer"
},
"has_data": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | none | none |
| active_count | integer(int32) | true | none | none |
| visible_count | integer(int32) | true | none | none |
| has_data | boolean | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | MyTasks |
| type | UpcomingEvents |
| type | MyQuotes |
| type | Catchup |
OrderResponse
{
"required": [
"view_id",
"groups"
],
"type": "object",
"properties": {
"view_id": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"required": [
"ordered_items"
],
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"ordered_items": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| view_id | string | true | none | none |
| groups | [GroupDescriptor] | true | none | none |
GroupDescriptor
{
"required": [
"ordered_items"
],
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"ordered_items": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| group_id | string | false | none | none |
| ordered_items | [string] | true | none | none |
OrderRequest
{
"required": [
"view_id",
"ordered_items"
],
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"view_id": {
"type": "string"
},
"ordered_items": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| group_id | string | false | none | none |
| view_id | string | true | none | none |
| ordered_items | [string] | true | none | none |
PromptResponse
{
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | true | none | none |
| version | integer(int64) | true | none | none |
| type | string | true | none | none |
| title | string | true | none | none |
| sender | string(uuid) | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [ParticipantResponse] | true | none | none |
| created | string(date-time) | true | none | none |
| last_updated | string(date-time) | true | none | none |
| importance | string | true | none | none |
| comments | [CommentResponse] | true | none | none |
| card_comment | CommentResponse | true | none | none |
| has_supportive_info | boolean | true | none | none |
| has_action | boolean | true | none | none |
| archive | UndoActionInfo | true | none | none |
| cancel | UndoActionInfo | true | none | none |
| is_sender | boolean | true | none | none |
| is_recipient | boolean | true | none | none |
| stacked_status | StackedStatus | true | none | none |
| quick_responses | string | true | none | none |
| pause | UndoActionInfo | true | none | none |
| question | QuestionInfo | true | none | none |
| edit | ActionInfo | true | none | none |
| tags | [string] | true | none | none |
| props | object | true | none | none |
| » additionalProperties | string | false | none | none |
| attach | LimitActionInfo | true | none | none |
| attachments | [AttachmentResponse] | true | none | none |
| assignable | boolean | true | none | none |
| is_personal | boolean | true | none | none |
| is_visible_to_team | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
| importance | none |
| importance | primary |
| importance | secondary |
| importance | tertiary |
| quick_responses | None |
| quick_responses | EventSlotSelected |
| quick_responses | QuoteAccepted |
| quick_responses | TaskCompleted |
| quick_responses | EventReceived |
| quick_responses | QuoteReceived |
| quick_responses | ChatReceived |
| quick_responses | InactiveTask |
| quick_responses | TaskCreated |
| quick_responses | AssigneeChanged |
| quick_responses | TaskNotAssigned |
ParticipantResponse
{
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| participant_guid | string(uuid) | true | none | none |
| is_sender | boolean | true | none | none |
| is_recipient | boolean | true | none | none |
| is_assignee | boolean | true | none | none |
| display_name | string | true | none | none |
| first_name | string | true | none | none |
| last_name | string | true | none | none |
| email_address | string | true | none | none |
| avatar | string | true | none | none |
| initials | string | true | none | none |
CommentResponse
{
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| comment_id | string(uuid) | true | none | none |
| text | string | true | none | none |
| type | string | true | none | none |
| created | string(date-time) | true | none | none |
| sender | string(uuid) | true | none | none |
| target | string(uuid) | false | none | none |
| is_sender | boolean | true | none | none |
| is_target | boolean | true | none | none |
| meta | PromptMetadata | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | Chat |
| type | Complete |
| type | SuggestComplete |
| type | Reopen |
| type | Acknowledge |
| type | Nudge |
| type | Accept |
| type | Decline |
| type | SelectSlot |
| type | UpdateSlot |
| type | Cancel |
| type | Uncancel |
| type | Pause |
| type | Unpause |
| type | Quick |
| type | SelectNone |
| type | Archive |
| type | Unarchive |
| type | UpdateAmount |
| type | Question |
| type | Addition |
| type | Answer |
| type | UndecidedEvent |
| type | UndecidedQuote |
| type | UpcomingEvent |
| type | SeedOfMine |
| type | SeedOfTheirs |
| type | AutoUnpause |
| type | UnacknowledgedTask |
| type | InactiveTask |
| type | Attach |
| type | AttachMany |
| type | NewTask |
| type | NewChat |
| type | NewEvent |
| type | NewQuote |
| type | Seed |
| type | SeenByAssignee |
| type | Assigned |
| type | Unassign |
| type | TaskNotAssigned |
UndoActionInfo
{
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| can_undo | boolean | true | none | none |
| done | boolean | true | none | none |
| date | string(date-time) | false | none | none |
| can | boolean | true | none | none |
StackedStatus
{
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| outstanding_comments | string | false | none | none |
| transient_state | string | false | none | none |
| terminal_state | string | false | none | none |
| color_group | string | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| outstanding_comments | None |
| outstanding_comments | Single |
| outstanding_comments | Many |
| transient_state | None |
| transient_state | QuestionedQuizmaster |
| transient_state | QuestionedContestant |
| transient_state | Paused |
| transient_state | TaskSuggestedCompleteSender |
| transient_state | TaskSuggestedCompleteRecipient |
| transient_state | EventDeclinedSender |
| transient_state | EventDeclinedRecipient |
| transient_state | Nudged |
| transient_state | TaskProposedSender |
| transient_state | TaskProposedRecipient |
| transient_state | EventActiveSender |
| transient_state | EventActiveRecipient |
| transient_state | QuoteActiveSender |
| transient_state | QuoteActiveRecipient |
| transient_state | EventProposedSender |
| transient_state | EventProposedRecipient |
| transient_state | QuoteProposedSender |
| transient_state | QuoteProposedRecipient |
| transient_state | TaskActive |
| transient_state | TaskUnread |
| transient_state | NoteUnread |
| transient_state | NoteActive |
| transient_state | TaskUnassigned |
| terminal_state | None |
| terminal_state | Cancelled |
| terminal_state | QuoteAccepted |
| terminal_state | QuoteRejected |
| terminal_state | EventAccepted |
| terminal_state | TaskCompleted |
| terminal_state | Archived |
| color_group | None |
| color_group | New |
| color_group | Active |
| color_group | Cancelled |
| color_group | Archived |
QuestionInfo
{
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| active | boolean | true | none | none |
| assigned | boolean | true | none | none |
| by | string(uuid) | false | none | none |
ActionInfo
{
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| done | boolean | true | none | none |
| date | string(date-time) | false | none | none |
| can | boolean | true | none | none |
LimitActionInfo
{
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer(int32) | true | none | none |
| remaining | integer(int32) | true | none | none |
| max | integer(int32) | true | none | none |
| min | integer(int32) | true | none | none |
| done | boolean | true | none | none |
| date | string(date-time) | false | none | none |
| can | boolean | true | none | none |
AttachmentResponse
{
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attachment_id | string(uuid) | true | none | none |
| document_id | string(uuid) | true | none | none |
| file_name | string | true | none | none |
| file_core | string | true | none | none |
| file_ext | string | true | none | none |
| mime_type | string | true | none | none |
| length | integer(int32) | true | none | none |
| user_id | string(uuid) | true | none | none |
PromptMetadata
{
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": "[Circular]"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | true | none | none |
| version | integer(int64) | true | none | none |
| importance | string | true | none | none |
| stacked_status | StackedStatus | true | none | none |
| quick_responses | string | true | none | none |
| read | ActionInfo | true | none | none |
| archive | UndoActionInfo | true | none | none |
| cancel | UndoActionInfo | true | none | none |
| pause | UndoActionInfo | true | none | none |
| last_updated | string(date-time) | true | none | none |
| question | QuestionInfo | true | none | none |
| edit | ActionInfo | true | none | none |
| tags | [string] | true | none | none |
| props | object | true | none | none |
| » additionalProperties | string | false | none | none |
| has_supportive_info | boolean | true | none | none |
| has_action | boolean | true | none | none |
| card_comment | CommentResponse | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| importance | none |
| importance | primary |
| importance | secondary |
| importance | tertiary |
| quick_responses | None |
| quick_responses | EventSlotSelected |
| quick_responses | QuoteAccepted |
| quick_responses | TaskCompleted |
| quick_responses | EventReceived |
| quick_responses | QuoteReceived |
| quick_responses | ChatReceived |
| quick_responses | InactiveTask |
| quick_responses | TaskCreated |
| quick_responses | AssigneeChanged |
| quick_responses | TaskNotAssigned |
UploadLimitsResponse
{
"required": [
"max_size",
"allowed_extensions",
"max_attachments"
],
"type": "object",
"properties": {
"max_size": {
"format": "int32",
"type": "integer"
},
"allowed_extensions": {
"type": "array",
"items": {
"type": "string"
}
},
"max_attachments": {
"format": "int32",
"type": "integer"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| max_size | integer(int32) | true | none | none |
| allowed_extensions | [string] | true | none | none |
| max_attachments | integer(int32) | true | none | none |
CatchupResponse
{
"required": [
"prompts",
"summary"
],
"type": "object",
"properties": {
"prompts": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
}
},
"summary": {
"type": "array",
"items": {
"required": [
"reason",
"count"
],
"type": "object",
"properties": {
"reason": {
"enum": [
"None",
"Unread",
"Questioned",
"UserComment",
"Answered",
"Nudged",
"ReminderSent",
"ChatCreated",
"TaskProposed",
"QuoteProposed",
"EventProposed",
"TaskAcknowledged",
"TaskSuggestedComplete",
"TaskCompleted",
"TaskReopened",
"QuoteAccepted",
"QuoteDeclined",
"EventAccepted",
"EventDeclined",
"EventUpdated",
"QuoteUpdated",
"TaskCancelled",
"TaskUncancelled",
"EventCancelled",
"EventUncancelled",
"QuoteCancelled",
"QuoteUncancelled",
"TaskPaused",
"TaskUnpaused",
"ChatArchived",
"QuoteArchived",
"ChatUnarchived",
"QuoteUnarchived",
"SeenByAssignee"
],
"type": "string"
},
"count": {
"format": "int32",
"type": "integer"
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| prompts | [PromptResponse] | true | none | none |
| summary | [CatchupSummaryEntry] | true | none | none |
CatchupSummaryEntry
{
"required": [
"reason",
"count"
],
"type": "object",
"properties": {
"reason": {
"enum": [
"None",
"Unread",
"Questioned",
"UserComment",
"Answered",
"Nudged",
"ReminderSent",
"ChatCreated",
"TaskProposed",
"QuoteProposed",
"EventProposed",
"TaskAcknowledged",
"TaskSuggestedComplete",
"TaskCompleted",
"TaskReopened",
"QuoteAccepted",
"QuoteDeclined",
"EventAccepted",
"EventDeclined",
"EventUpdated",
"QuoteUpdated",
"TaskCancelled",
"TaskUncancelled",
"EventCancelled",
"EventUncancelled",
"QuoteCancelled",
"QuoteUncancelled",
"TaskPaused",
"TaskUnpaused",
"ChatArchived",
"QuoteArchived",
"ChatUnarchived",
"QuoteUnarchived",
"SeenByAssignee"
],
"type": "string"
},
"count": {
"format": "int32",
"type": "integer"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| reason | string | true | none | none |
| count | integer(int32) | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| reason | None |
| reason | Unread |
| reason | Questioned |
| reason | UserComment |
| reason | Answered |
| reason | Nudged |
| reason | ReminderSent |
| reason | ChatCreated |
| reason | TaskProposed |
| reason | QuoteProposed |
| reason | EventProposed |
| reason | TaskAcknowledged |
| reason | TaskSuggestedComplete |
| reason | TaskCompleted |
| reason | TaskReopened |
| reason | QuoteAccepted |
| reason | QuoteDeclined |
| reason | EventAccepted |
| reason | EventDeclined |
| reason | EventUpdated |
| reason | QuoteUpdated |
| reason | TaskCancelled |
| reason | TaskUncancelled |
| reason | EventCancelled |
| reason | EventUncancelled |
| reason | QuoteCancelled |
| reason | QuoteUncancelled |
| reason | TaskPaused |
| reason | TaskUnpaused |
| reason | ChatArchived |
| reason | QuoteArchived |
| reason | ChatUnarchived |
| reason | QuoteUnarchived |
| reason | SeenByAssignee |
PromptTypeResponse
{
"required": [
"type",
"assign",
"title",
"comment",
"amount",
"slot_picker",
"seed",
"attachments",
"multiple_participants",
"allow_personal",
"allow_unassigned",
"toggle_team_visibility"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"assign": {
"enum": [
"None",
"Recipient",
"Sender",
"Selectable"
],
"type": "string"
},
"title": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"comment": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"amount": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"slot_picker": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"seed": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"attachments": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"multiple_participants": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"allow_personal": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"allow_unassigned": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"toggle_team_visibility": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | none | none |
| assign | string | true | none | none |
| title | string | true | none | none |
| comment | string | true | none | none |
| amount | string | true | none | none |
| slot_picker | string | true | none | none |
| seed | string | true | none | none |
| attachments | string | true | none | none |
| multiple_participants | string | true | none | none |
| allow_personal | string | true | none | none |
| allow_unassigned | string | true | none | none |
| toggle_team_visibility | string | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
| assign | None |
| assign | Recipient |
| assign | Sender |
| assign | Selectable |
| title | None |
| title | Read |
| title | Create |
| title | Edit |
| title | Delete |
| title | Seed |
| comment | None |
| comment | Read |
| comment | Create |
| comment | Edit |
| comment | Delete |
| comment | Seed |
| amount | None |
| amount | Read |
| amount | Create |
| amount | Edit |
| amount | Delete |
| amount | Seed |
| slot_picker | None |
| slot_picker | Read |
| slot_picker | Create |
| slot_picker | Edit |
| slot_picker | Delete |
| slot_picker | Seed |
| seed | None |
| seed | Read |
| seed | Create |
| seed | Edit |
| seed | Delete |
| seed | Seed |
| attachments | None |
| attachments | Read |
| attachments | Create |
| attachments | Edit |
| attachments | Delete |
| attachments | Seed |
| multiple_participants | None |
| multiple_participants | Read |
| multiple_participants | Create |
| multiple_participants | Edit |
| multiple_participants | Delete |
| multiple_participants | Seed |
| allow_personal | None |
| allow_personal | Read |
| allow_personal | Create |
| allow_personal | Edit |
| allow_personal | Delete |
| allow_personal | Seed |
| allow_unassigned | None |
| allow_unassigned | Read |
| allow_unassigned | Create |
| allow_unassigned | Edit |
| allow_unassigned | Delete |
| allow_unassigned | Seed |
| toggle_team_visibility | None |
| toggle_team_visibility | Read |
| toggle_team_visibility | Create |
| toggle_team_visibility | Edit |
| toggle_team_visibility | Delete |
| toggle_team_visibility | Seed |
CurrencyResponse
{
"required": [
"code",
"symbol"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | none | none |
| symbol | string | true | none | none |
QuickResponseDescriptor
{
"required": [
"type",
"items"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"enum": [
"None",
"Thanks",
"ThatsGreat",
"ThumbsUpEmoji",
"SeeYouThen",
"WillBeInTouch",
"Nevermind",
"ThanksForConsidering",
"WontForget",
"WaitingOnSomething",
"LetMeThinkAboutIt",
"IllCheckMyDiary",
"ThanksIllDecideAsap",
"GiveMe48Hours",
"GoodToKnow",
"FaceScreamingInFearEmoji",
"ElephantEmoji",
"FlushedFaceEmoji",
"GotIt",
"WillDo",
"SorryNotMe",
"IllHaveAThink",
"ThinkingFaceEmoji"
],
"type": "string"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | none | none |
| items | [string] | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | EventSlotSelected |
| type | QuoteAccepted |
| type | TaskCompleted |
| type | EventReceived |
| type | QuoteReceived |
| type | ChatReceived |
| type | InactiveTask |
| type | TaskCreated |
| type | AssigneeChanged |
| type | TaskNotAssigned |
DownloadOptionsResponse
{
"required": [
"inline_extensions"
],
"type": "object",
"properties": {
"inline_extensions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| inline_extensions | [string] | true | none | none |
CommentRequest
{
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| text | string | true | none | none |
| type | string | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | Chat |
| type | Complete |
| type | SuggestComplete |
| type | Reopen |
| type | Acknowledge |
| type | Nudge |
| type | Accept |
| type | Decline |
| type | SelectSlot |
| type | UpdateSlot |
| type | Cancel |
| type | Uncancel |
| type | Pause |
| type | Unpause |
| type | Quick |
| type | SelectNone |
| type | Archive |
| type | Unarchive |
| type | UpdateAmount |
| type | Question |
| type | Addition |
| type | Answer |
| type | UndecidedEvent |
| type | UndecidedQuote |
| type | UpcomingEvent |
| type | SeedOfMine |
| type | SeedOfTheirs |
| type | AutoUnpause |
| type | UnacknowledgedTask |
| type | InactiveTask |
| type | Attach |
| type | AttachMany |
| type | NewTask |
| type | NewChat |
| type | NewEvent |
| type | NewQuote |
| type | Seed |
| type | SeenByAssignee |
| type | Assigned |
| type | Unassign |
| type | TaskNotAssigned |
ViewDescriptor
{
"type": "object",
"properties": {
"view_id": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"filter_by": {
"type": "array",
"items": {
"type": "array",
"items": {
"required": [
"tag",
"exclude"
],
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"exclude": {
"type": "boolean"
}
}
}
}
},
"order_by": {
"type": "array",
"items": {
"required": [
"prop",
"desc"
],
"type": "object",
"properties": {
"prop": {
"type": "string"
},
"desc": {
"type": "boolean"
}
}
}
},
"groups": {
"type": "array",
"items": "[Circular]"
},
"limit": {
"format": "int32",
"type": "integer"
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| view_id | string | false | none | none |
| groups | [ViewGroupDescriptor] | false | none | none |
ViewGroupDescriptor
{
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"filter_by": {
"type": "array",
"items": {
"type": "array",
"items": {
"required": [
"tag",
"exclude"
],
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"exclude": {
"type": "boolean"
}
}
}
}
},
"order_by": {
"type": "array",
"items": {
"required": [
"prop",
"desc"
],
"type": "object",
"properties": {
"prop": {
"type": "string"
},
"desc": {
"type": "boolean"
}
}
}
},
"groups": {
"type": "array",
"items": "[Circular]"
},
"limit": {
"format": "int32",
"type": "integer"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| group_id | string | false | none | none |
| filter_by | [array] | false | none | none |
| order_by | [ViewOrderDescriptor] | false | none | none |
| groups | [ViewGroupDescriptor] | false | none | none |
| limit | integer(int32) | false | none | none |
ViewFilterDescriptor
{
"required": [
"tag",
"exclude"
],
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"exclude": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tag | string | true | none | none |
| exclude | boolean | true | none | none |
ViewOrderDescriptor
{
"required": [
"prop",
"desc"
],
"type": "object",
"properties": {
"prop": {
"type": "string"
},
"desc": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| prop | string | true | none | none |
| desc | boolean | true | none | none |
ScheduleSlot
{
"required": [
"label",
"from",
"to",
"available",
"start_times"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"available": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| label | string | true | none | none |
| from | string(date-time) | true | none | none |
| to | string(date-time) | true | none | none |
| available | boolean | true | none | none |
| start_times | [integer] | true | none | none |
ScheduleTableResponse
{
"required": [
"header",
"rows"
],
"type": "object",
"properties": {
"header": {
"type": "array",
"items": {
"format": "date-time",
"type": "string"
}
},
"rows": {
"type": "array",
"items": {
"required": [
"label",
"data"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"required": [
"label",
"from",
"to",
"available",
"start_times"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"available": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| header | [string] | true | none | none |
| rows | [ScheduleRow] | true | none | none |
ScheduleRow
{
"required": [
"label",
"data"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"required": [
"label",
"from",
"to",
"available",
"start_times"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"available": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| label | string | true | none | none |
| data | [ScheduleSlot] | true | none | none |
TaskPromptRequest
{
"required": [
"type",
"title",
"recipient",
"participants",
"comment",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"comment": {
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | read-only | none |
| assigned | string(uuid) | false | none | none |
| title | string | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [string] | true | none | none |
| comment | CommentRequest | true | none | none |
| attachments | [string] | true | none | none |
| permissions | Permissions | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
Permissions
{
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| team_visible | boolean | true | none | none |
TaskPromptResponse
{
"required": [
"read",
"nudge",
"acknowledge",
"is_assignee",
"complete",
"suggest_complete",
"seen",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"acknowledge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"complete": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"suggest_complete": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"seen": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| read | ReadInfo | true | none | none |
| nudge | UserActionInfo | true | none | none |
| acknowledge | ActionInfo | true | none | none |
| assigned | string(uuid) | false | none | none |
| is_assignee | boolean | true | none | none |
| complete | ActionInfo | true | none | none |
| suggest_complete | UserActionInfo | true | none | none |
| seen | ActionInfo | true | none | none |
| id | string(uuid) | true | none | none |
| version | integer(int64) | true | none | none |
| type | string | true | none | none |
| title | string | true | none | none |
| sender | string(uuid) | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [ParticipantResponse] | true | none | none |
| created | string(date-time) | true | none | none |
| last_updated | string(date-time) | true | none | none |
| importance | string | true | none | none |
| comments | [CommentResponse] | true | none | none |
| card_comment | CommentResponse | true | none | none |
| has_supportive_info | boolean | true | none | none |
| has_action | boolean | true | none | none |
| archive | UndoActionInfo | true | none | none |
| cancel | UndoActionInfo | true | none | none |
| is_sender | boolean | true | none | none |
| is_recipient | boolean | true | none | none |
| stacked_status | StackedStatus | true | none | none |
| quick_responses | string | true | none | none |
| pause | UndoActionInfo | true | none | none |
| question | QuestionInfo | true | none | none |
| edit | ActionInfo | true | none | none |
| tags | [string] | true | none | none |
| props | object | true | none | none |
| » additionalProperties | string | false | none | none |
| attach | LimitActionInfo | true | none | none |
| attachments | [AttachmentResponse] | true | none | none |
| assignable | boolean | true | none | none |
| is_personal | boolean | true | none | none |
| is_visible_to_team | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
| importance | none |
| importance | primary |
| importance | secondary |
| importance | tertiary |
| quick_responses | None |
| quick_responses | EventSlotSelected |
| quick_responses | QuoteAccepted |
| quick_responses | TaskCompleted |
| quick_responses | EventReceived |
| quick_responses | QuoteReceived |
| quick_responses | ChatReceived |
| quick_responses | InactiveTask |
| quick_responses | TaskCreated |
| quick_responses | AssigneeChanged |
| quick_responses | TaskNotAssigned |
ReadInfo
{
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| unread_chat_comments | boolean | true | none | none |
| done | boolean | true | none | none |
| date | string(date-time) | false | none | none |
| can | boolean | true | none | none |
UserActionInfo
{
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| by | string(uuid) | false | none | none |
| done | boolean | true | none | none |
| date | string(date-time) | false | none | none |
| can | boolean | true | none | none |
SeedRequest
{
"required": [
"comment_id",
"title",
"Type",
"participants",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"Type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| comment_id | string(uuid) | true | none | none |
| title | string | true | none | none |
| Type | string | true | read-only | none |
| assigned | string(uuid) | false | none | none |
| participants | [string] | true | none | none |
| attachments | [string] | true | none | none |
| permissions | Permissions | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| Type | None |
| Type | Chat |
| Type | Task |
| Type | Quote |
| Type | Event |
ChatPromptRequest
{
"required": [
"type",
"title",
"recipient",
"participants",
"comment",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"comment": {
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | read-only | none |
| title | string | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [string] | true | none | none |
| comment | CommentRequest | true | none | none |
| attachments | [string] | true | none | none |
| permissions | Permissions | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
ChatPromptResponse
{
"required": [
"read",
"is_nudgeable",
"assigned",
"is_assignee",
"is_self_assigned",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_nudgeable": {
"type": "boolean"
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| read | ReadInfo | true | none | none |
| is_nudgeable | boolean | true | none | none |
| assigned | string(uuid) | true | none | none |
| is_assignee | boolean | true | none | none |
| is_self_assigned | boolean | true | none | none |
| id | string(uuid) | true | none | none |
| version | integer(int64) | true | none | none |
| type | string | true | none | none |
| title | string | true | none | none |
| sender | string(uuid) | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [ParticipantResponse] | true | none | none |
| created | string(date-time) | true | none | none |
| last_updated | string(date-time) | true | none | none |
| importance | string | true | none | none |
| comments | [CommentResponse] | true | none | none |
| card_comment | CommentResponse | true | none | none |
| has_supportive_info | boolean | true | none | none |
| has_action | boolean | true | none | none |
| archive | UndoActionInfo | true | none | none |
| cancel | UndoActionInfo | true | none | none |
| is_sender | boolean | true | none | none |
| is_recipient | boolean | true | none | none |
| stacked_status | StackedStatus | true | none | none |
| quick_responses | string | true | none | none |
| pause | UndoActionInfo | true | none | none |
| question | QuestionInfo | true | none | none |
| edit | ActionInfo | true | none | none |
| tags | [string] | true | none | none |
| props | object | true | none | none |
| » additionalProperties | string | false | none | none |
| attach | LimitActionInfo | true | none | none |
| attachments | [AttachmentResponse] | true | none | none |
| assignable | boolean | true | none | none |
| is_personal | boolean | true | none | none |
| is_visible_to_team | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
| importance | none |
| importance | primary |
| importance | secondary |
| importance | tertiary |
| quick_responses | None |
| quick_responses | EventSlotSelected |
| quick_responses | QuoteAccepted |
| quick_responses | TaskCompleted |
| quick_responses | EventReceived |
| quick_responses | QuoteReceived |
| quick_responses | ChatReceived |
| quick_responses | InactiveTask |
| quick_responses | TaskCreated |
| quick_responses | AssigneeChanged |
| quick_responses | TaskNotAssigned |
QuotePromptRequest
{
"required": [
"type",
"assigned",
"amount",
"currency_code",
"title",
"recipient",
"participants",
"comment",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"assigned": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000"
},
"amount": {
"format": "double",
"type": "number"
},
"currency_code": {
"type": "string"
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"comment": {
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | read-only | none |
| assigned | string(uuid) | true | read-only | none |
| amount | number(double) | true | none | none |
| currency_code | string | true | none | none |
| title | string | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [string] | true | none | none |
| comment | CommentRequest | true | none | none |
| attachments | [string] | true | none | none |
| permissions | Permissions | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
QuotePromptResponse
{
"required": [
"read",
"nudge",
"is_assignee",
"is_self_assigned",
"amount",
"currency",
"is_priceable",
"decide",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"amount": {
"format": "double",
"type": "number"
},
"currency": {
"required": [
"code",
"symbol"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"is_priceable": {
"type": "boolean"
},
"decide": {
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| read | ReadInfo | true | none | none |
| nudge | UserActionInfo | true | none | none |
| assigned | string(uuid) | false | none | none |
| is_assignee | boolean | true | none | none |
| is_self_assigned | boolean | true | none | none |
| amount | number(double) | true | none | none |
| currency | CurrencyResponse | true | none | none |
| is_priceable | boolean | true | none | none |
| decide | DecisionInfo | true | none | none |
| id | string(uuid) | true | none | none |
| version | integer(int64) | true | none | none |
| type | string | true | none | none |
| title | string | true | none | none |
| sender | string(uuid) | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [ParticipantResponse] | true | none | none |
| created | string(date-time) | true | none | none |
| last_updated | string(date-time) | true | none | none |
| importance | string | true | none | none |
| comments | [CommentResponse] | true | none | none |
| card_comment | CommentResponse | true | none | none |
| has_supportive_info | boolean | true | none | none |
| has_action | boolean | true | none | none |
| archive | UndoActionInfo | true | none | none |
| cancel | UndoActionInfo | true | none | none |
| is_sender | boolean | true | none | none |
| is_recipient | boolean | true | none | none |
| stacked_status | StackedStatus | true | none | none |
| quick_responses | string | true | none | none |
| pause | UndoActionInfo | true | none | none |
| question | QuestionInfo | true | none | none |
| edit | ActionInfo | true | none | none |
| tags | [string] | true | none | none |
| props | object | true | none | none |
| » additionalProperties | string | false | none | none |
| attach | LimitActionInfo | true | none | none |
| attachments | [AttachmentResponse] | true | none | none |
| assignable | boolean | true | none | none |
| is_personal | boolean | true | none | none |
| is_visible_to_team | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
| importance | none |
| importance | primary |
| importance | secondary |
| importance | tertiary |
| quick_responses | None |
| quick_responses | EventSlotSelected |
| quick_responses | QuoteAccepted |
| quick_responses | TaskCompleted |
| quick_responses | EventReceived |
| quick_responses | QuoteReceived |
| quick_responses | ChatReceived |
| quick_responses | InactiveTask |
| quick_responses | TaskCreated |
| quick_responses | AssigneeChanged |
| quick_responses | TaskNotAssigned |
DecisionInfo
{
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| decision | string | true | none | none |
| done | boolean | true | none | none |
| date | string(date-time) | false | none | none |
| can | boolean | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| decision | None |
| decision | Awaiting |
| decision | Accepted |
| decision | Declined |
EventPromptRequest
{
"required": [
"type",
"assigned",
"slots",
"title",
"recipient",
"participants",
"comment",
"attachments",
"permissions"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string",
"readOnly": true
},
"assigned": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000"
},
"slots": {
"type": "array",
"items": {
"required": [
"from",
"to",
"offset",
"specific_time_selected"
],
"type": "object",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"specific_time_selected": {
"type": "boolean"
}
}
}
},
"title": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"comment": {
"required": [
"text",
"type"
],
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
}
}
},
"attachments": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"permissions": {
"required": [
"team_visible"
],
"type": "object",
"properties": {
"team_visible": {
"type": "boolean"
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | read-only | none |
| assigned | string(uuid) | true | read-only | none |
| slots | [SlotRequest] | true | none | none |
| title | string | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [string] | true | none | none |
| comment | CommentRequest | true | none | none |
| attachments | [string] | true | none | none |
| permissions | Permissions | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
SlotRequest
{
"required": [
"from",
"to",
"offset",
"specific_time_selected"
],
"type": "object",
"properties": {
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"specific_time_selected": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| from | string(date-time) | true | none | none |
| to | string(date-time) | true | none | none |
| offset | integer(int32) | true | none | none |
| specific_time_selected | boolean | true | none | none |
EventPromptResponse
{
"required": [
"read",
"nudge",
"assigned",
"is_assignee",
"is_self_assigned",
"decide",
"select",
"slots",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"decide": {
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"select": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"selected_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"slots": {
"type": "array",
"items": {
"required": [
"slot_guid",
"from",
"to",
"offset",
"available",
"specific_time_selected",
"start_times"
],
"type": "object",
"properties": {
"slot_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"available": {
"type": "boolean"
},
"specific_time_selected": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| read | ReadInfo | true | none | none |
| nudge | UserActionInfo | true | none | none |
| assigned | string(uuid) | true | none | none |
| is_assignee | boolean | true | none | none |
| is_self_assigned | boolean | true | none | none |
| decide | DecisionInfo | true | none | none |
| select | SelectionInfo | true | none | none |
| slots | [SlotResponse] | true | none | none |
| id | string(uuid) | true | none | none |
| version | integer(int64) | true | none | none |
| type | string | true | none | none |
| title | string | true | none | none |
| sender | string(uuid) | true | none | none |
| recipient | string(uuid) | true | none | none |
| participants | [ParticipantResponse] | true | none | none |
| created | string(date-time) | true | none | none |
| last_updated | string(date-time) | true | none | none |
| importance | string | true | none | none |
| comments | [CommentResponse] | true | none | none |
| card_comment | CommentResponse | true | none | none |
| has_supportive_info | boolean | true | none | none |
| has_action | boolean | true | none | none |
| archive | UndoActionInfo | true | none | none |
| cancel | UndoActionInfo | true | none | none |
| is_sender | boolean | true | none | none |
| is_recipient | boolean | true | none | none |
| stacked_status | StackedStatus | true | none | none |
| quick_responses | string | true | none | none |
| pause | UndoActionInfo | true | none | none |
| question | QuestionInfo | true | none | none |
| edit | ActionInfo | true | none | none |
| tags | [string] | true | none | none |
| props | object | true | none | none |
| » additionalProperties | string | false | none | none |
| attach | LimitActionInfo | true | none | none |
| attachments | [AttachmentResponse] | true | none | none |
| assignable | boolean | true | none | none |
| is_personal | boolean | true | none | none |
| is_visible_to_team | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | None |
| type | Chat |
| type | Task |
| type | Quote |
| type | Event |
| importance | none |
| importance | primary |
| importance | secondary |
| importance | tertiary |
| quick_responses | None |
| quick_responses | EventSlotSelected |
| quick_responses | QuoteAccepted |
| quick_responses | TaskCompleted |
| quick_responses | EventReceived |
| quick_responses | QuoteReceived |
| quick_responses | ChatReceived |
| quick_responses | InactiveTask |
| quick_responses | TaskCreated |
| quick_responses | AssigneeChanged |
| quick_responses | TaskNotAssigned |
SelectionInfo
{
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"selected_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| selected_guid | string(uuid) | false | none | none |
| done | boolean | true | none | none |
| date | string(date-time) | false | none | none |
| can | boolean | true | none | none |
SlotResponse
{
"required": [
"slot_guid",
"from",
"to",
"offset",
"available",
"specific_time_selected",
"start_times"
],
"type": "object",
"properties": {
"slot_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"available": {
"type": "boolean"
},
"specific_time_selected": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| slot_guid | string(uuid) | true | none | none |
| from | string(date-time) | true | none | none |
| to | string(date-time) | true | none | none |
| offset | integer(int32) | true | none | none |
| available | boolean | true | none | none |
| specific_time_selected | boolean | true | none | none |
| start_times | [integer] | true | none | none |
AmountRequest
{
"required": [
"amount",
"currency_code"
],
"type": "object",
"properties": {
"amount": {
"format": "double",
"type": "number"
},
"currency_code": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amount | number(double) | true | none | none |
| currency_code | string | true | none | none |
ReadResponse
{
"required": [
"id",
"prompt_id",
"prompt_type",
"read",
"reader",
"meta",
"comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"prompt_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"prompt_type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"read": {
"format": "date-time",
"type": "string"
},
"reader": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": "[Circular]"
}
}
}
},
"comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string(uuid) | true | none | none |
| prompt_id | string(uuid) | true | none | none |
| prompt_type | string | true | none | none |
| read | string(date-time) | true | none | none |
| reader | string(uuid) | true | none | none |
| meta | PromptMetadata | true | none | none |
| comment | CommentResponse | true | none | none |
Enumerated Values
| Property | Value |
|---|---|
| prompt_type | None |
| prompt_type | Chat |
| prompt_type | Task |
| prompt_type | Quote |
| prompt_type | Event |
AttachmentRequest
{
"required": [
"documents"
],
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| documents | [string] | true | none | none |
AssignmentRequest
{
"type": "object",
"properties": {
"assignee": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| assignee | string(uuid) | false | none | none |
PromptVisibilityUpdateRequest
{
"required": [
"team_visibility"
],
"type": "object",
"properties": {
"team_visibility": {
"type": "boolean"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| team_visibility | boolean | true | none | none |
UserProfileRequest
{
"required": [
"account_name",
"about",
"team_role"
],
"type": "object",
"properties": {
"account_name": {
"type": "string"
},
"about": {
"type": "string"
},
"team_role": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| account_name | string | true | none | none |
| about | string | true | none | none |
| team_role | string | true | none | none |
ErrorResponse
{
"required": [
"http_status_code",
"error_code"
],
"type": "object",
"properties": {
"http_status_code": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string"
},
"error_code": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| http_status_code | string | true | none | none |
| error_code | string | true | none | none |
| messages | [string] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| http_status_code | Continue |
| http_status_code | SwitchingProtocols |
| http_status_code | OK |
| http_status_code | Created |
| http_status_code | Accepted |
| http_status_code | NonAuthoritativeInformation |
| http_status_code | NoContent |
| http_status_code | ResetContent |
| http_status_code | PartialContent |
| http_status_code | MultipleChoices |
| http_status_code | Ambiguous |
| http_status_code | MovedPermanently |
| http_status_code | Moved |
| http_status_code | Found |
| http_status_code | Redirect |
| http_status_code | SeeOther |
| http_status_code | RedirectMethod |
| http_status_code | NotModified |
| http_status_code | UseProxy |
| http_status_code | Unused |
| http_status_code | TemporaryRedirect |
| http_status_code | RedirectKeepVerb |
| http_status_code | BadRequest |
| http_status_code | Unauthorized |
| http_status_code | PaymentRequired |
| http_status_code | Forbidden |
| http_status_code | NotFound |
| http_status_code | MethodNotAllowed |
| http_status_code | NotAcceptable |
| http_status_code | ProxyAuthenticationRequired |
| http_status_code | RequestTimeout |
| http_status_code | Conflict |
| http_status_code | Gone |
| http_status_code | LengthRequired |
| http_status_code | PreconditionFailed |
| http_status_code | RequestEntityTooLarge |
| http_status_code | RequestUriTooLong |
| http_status_code | UnsupportedMediaType |
| http_status_code | RequestedRangeNotSatisfiable |
| http_status_code | ExpectationFailed |
| http_status_code | UpgradeRequired |
| http_status_code | InternalServerError |
| http_status_code | NotImplemented |
| http_status_code | BadGateway |
| http_status_code | ServiceUnavailable |
| http_status_code | GatewayTimeout |
| http_status_code | HttpVersionNotSupported |
TeamResponse
{
"required": [
"members"
],
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"required": [
"user_id",
"account_id",
"email_address",
"first_name",
"last_name",
"avatar",
"invitation_pending",
"roles"
],
"type": "object",
"properties": {
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"account_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"email_address": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"invitation_pending": {
"type": "boolean"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| members | [TeamMemberResponse] | true | none | none |
TeamMemberResponse
{
"required": [
"user_id",
"account_id",
"email_address",
"first_name",
"last_name",
"avatar",
"invitation_pending",
"roles"
],
"type": "object",
"properties": {
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"account_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"email_address": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"invitation_pending": {
"type": "boolean"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| user_id | string(uuid) | true | none | none |
| account_id | string(uuid) | true | none | none |
| email_address | string | true | none | none |
| first_name | string | true | none | none |
| last_name | string | true | none | none |
| avatar | Avatar | true | none | none |
| invitation_pending | boolean | true | none | none |
| roles | [string] | true | none | none |
TeamInviteResponse
{
"required": [
"user_guid",
"account_guid"
],
"type": "object",
"properties": {
"user_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"account_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| user_guid | string(uuid) | true | none | none |
| account_guid | string(uuid) | true | none | none |
TeamInviteRequest
{
"required": [
"email_address"
],
"type": "object",
"properties": {
"email_address": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| email_address | string | true | none | none |
IServiceResponse_UserProfileResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"first_name",
"last_name",
"email_address",
"account_name",
"account_description",
"about",
"initials",
"avatar",
"bot_version",
"team_role"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
},
"about": {
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"bot_version": {
"format": "int32",
"type": "integer"
},
"team_role": {
"type": "string"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | UserProfileResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_VersionResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"version"
],
"type": "object",
"properties": {
"version": {
"format": "int32",
"type": "integer"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | VersionResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_PersonContactResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"first_name",
"last_name",
"email_address",
"contact_guid",
"display_name",
"user_guid",
"unread_count",
"active_count",
"total_count_in",
"total_count_out",
"last_activity",
"initials",
"tags",
"props",
"is_team"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"contact_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"display_name": {
"type": "string"
},
"user_guid": {
"type": "string"
},
"unread_count": {
"format": "int32",
"type": "integer"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"total_count_in": {
"format": "int32",
"type": "integer"
},
"total_count_out": {
"format": "int32",
"type": "integer"
},
"last_activity": {
"format": "date-time",
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"is_bot": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"is_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | PersonContactResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_PersonContactResponseArray_
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"first_name",
"last_name",
"email_address",
"contact_guid",
"display_name",
"user_guid",
"unread_count",
"active_count",
"total_count_in",
"total_count_out",
"last_activity",
"initials",
"tags",
"props",
"is_team"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"contact_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"display_name": {
"type": "string"
},
"user_guid": {
"type": "string"
},
"unread_count": {
"format": "int32",
"type": "integer"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"total_count_in": {
"format": "int32",
"type": "integer"
},
"total_count_out": {
"format": "int32",
"type": "integer"
},
"last_activity": {
"format": "date-time",
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"is_bot": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"is_team": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [PersonContactResponse] | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_DocumentResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"document_id",
"file_name",
"mime_type",
"length",
"uri"
],
"type": "object",
"properties": {
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int64",
"type": "integer"
},
"uri": {
"type": "string"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | DocumentResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_LocalizationResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"localizations",
"language",
"culture"
],
"type": "object",
"properties": {
"localizations": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"language": {
"type": "string"
},
"culture": {
"type": "string"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | LocalizationResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_AccountProfileResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"account_guid",
"account_name",
"account_description"
],
"type": "object",
"properties": {
"account_guid": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | AccountProfileResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_List_FilterResponse_
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"type",
"active_count",
"visible_count",
"has_data"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"MyTasks",
"UpcomingEvents",
"MyQuotes",
"Catchup"
],
"type": "string"
},
"active_count": {
"format": "int32",
"type": "integer"
},
"visible_count": {
"format": "int32",
"type": "integer"
},
"has_data": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [FilterResponse] | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_OrderResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"view_id",
"groups"
],
"type": "object",
"properties": {
"view_id": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"required": [
"ordered_items"
],
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"ordered_items": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | OrderResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_PromptResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | PromptResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_UploadLimitsResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"max_size",
"allowed_extensions",
"max_attachments"
],
"type": "object",
"properties": {
"max_size": {
"format": "int32",
"type": "integer"
},
"allowed_extensions": {
"type": "array",
"items": {
"type": "string"
}
},
"max_attachments": {
"format": "int32",
"type": "integer"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | UploadLimitsResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_String_
{
"type": "object",
"properties": {
"result": {
"type": "string",
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | string | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_PromptResponseArray_
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [PromptResponse] | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_CatchupResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"prompts",
"summary"
],
"type": "object",
"properties": {
"prompts": {
"type": "array",
"items": {
"required": [
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
}
},
"summary": {
"type": "array",
"items": {
"required": [
"reason",
"count"
],
"type": "object",
"properties": {
"reason": {
"enum": [
"None",
"Unread",
"Questioned",
"UserComment",
"Answered",
"Nudged",
"ReminderSent",
"ChatCreated",
"TaskProposed",
"QuoteProposed",
"EventProposed",
"TaskAcknowledged",
"TaskSuggestedComplete",
"TaskCompleted",
"TaskReopened",
"QuoteAccepted",
"QuoteDeclined",
"EventAccepted",
"EventDeclined",
"EventUpdated",
"QuoteUpdated",
"TaskCancelled",
"TaskUncancelled",
"EventCancelled",
"EventUncancelled",
"QuoteCancelled",
"QuoteUncancelled",
"TaskPaused",
"TaskUnpaused",
"ChatArchived",
"QuoteArchived",
"ChatUnarchived",
"QuoteUnarchived",
"SeenByAssignee"
],
"type": "string"
},
"count": {
"format": "int32",
"type": "integer"
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | CatchupResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_PromptTypeResponseArray_
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"type",
"assign",
"title",
"comment",
"amount",
"slot_picker",
"seed",
"attachments",
"multiple_participants",
"allow_personal",
"allow_unassigned",
"toggle_team_visibility"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"assign": {
"enum": [
"None",
"Recipient",
"Sender",
"Selectable"
],
"type": "string"
},
"title": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"comment": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"amount": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"slot_picker": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"seed": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"attachments": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"multiple_participants": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"allow_personal": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"allow_unassigned": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
},
"toggle_team_visibility": {
"enum": [
"None",
"Read",
"Create",
"Edit",
"Delete",
"Seed"
],
"type": "string"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [PromptTypeResponse] | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_CurrencyResponseArray_
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"code",
"symbol"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [CurrencyResponse] | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_QuickResponseDescriptorArray_
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"type",
"items"
],
"type": "object",
"properties": {
"type": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"enum": [
"None",
"Thanks",
"ThatsGreat",
"ThumbsUpEmoji",
"SeeYouThen",
"WillBeInTouch",
"Nevermind",
"ThanksForConsidering",
"WontForget",
"WaitingOnSomething",
"LetMeThinkAboutIt",
"IllCheckMyDiary",
"ThanksIllDecideAsap",
"GiveMe48Hours",
"GoodToKnow",
"FaceScreamingInFearEmoji",
"ElephantEmoji",
"FlushedFaceEmoji",
"GotIt",
"WillDo",
"SorryNotMe",
"IllHaveAThink",
"ThinkingFaceEmoji"
],
"type": "string"
}
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [QuickResponseDescriptor] | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_DownloadOptionsResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"inline_extensions"
],
"type": "object",
"properties": {
"inline_extensions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | DownloadOptionsResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_CommentResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | CommentResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_ViewDescriptorArray_
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"view_id": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"filter_by": {
"type": "array",
"items": {
"type": "array",
"items": {
"required": [
"tag",
"exclude"
],
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"exclude": {
"type": "boolean"
}
}
}
}
},
"order_by": {
"type": "array",
"items": {
"required": [
"prop",
"desc"
],
"type": "object",
"properties": {
"prop": {
"type": "string"
},
"desc": {
"type": "boolean"
}
}
}
},
"groups": {
"type": "array",
"items": "[Circular]"
},
"limit": {
"format": "int32",
"type": "integer"
}
}
}
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [ViewDescriptor] | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_List_ScheduleSlot_
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"required": [
"label",
"from",
"to",
"available",
"start_times"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"available": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
},
"readOnly": true
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [ScheduleSlot] | false | read-only | none |
| error | IServiceError | false | none | none |
IServiceResponse_ScheduleTableResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"header",
"rows"
],
"type": "object",
"properties": {
"header": {
"type": "array",
"items": {
"format": "date-time",
"type": "string"
}
},
"rows": {
"type": "array",
"items": {
"required": [
"label",
"data"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"required": [
"label",
"from",
"to",
"available",
"start_times"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"available": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | ScheduleTableResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_TaskPromptResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"acknowledge",
"is_assignee",
"complete",
"suggest_complete",
"seen",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"acknowledge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"complete": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"suggest_complete": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"seen": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | TaskPromptResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_ChatPromptResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"is_nudgeable",
"assigned",
"is_assignee",
"is_self_assigned",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_nudgeable": {
"type": "boolean"
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | ChatPromptResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_QuotePromptResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"is_assignee",
"is_self_assigned",
"amount",
"currency",
"is_priceable",
"decide",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"amount": {
"format": "double",
"type": "number"
},
"currency": {
"required": [
"code",
"symbol"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"is_priceable": {
"type": "boolean"
},
"decide": {
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | QuotePromptResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_EventPromptResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"read",
"nudge",
"assigned",
"is_assignee",
"is_self_assigned",
"decide",
"select",
"slots",
"id",
"version",
"type",
"title",
"sender",
"recipient",
"participants",
"created",
"last_updated",
"importance",
"comments",
"card_comment",
"has_supportive_info",
"has_action",
"archive",
"cancel",
"is_sender",
"is_recipient",
"stacked_status",
"quick_responses",
"pause",
"question",
"edit",
"tags",
"props",
"attach",
"attachments",
"assignable",
"is_personal"
],
"type": "object",
"properties": {
"read": {
"required": [
"unread_chat_comments",
"done",
"can"
],
"type": "object",
"properties": {
"unread_chat_comments": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"nudge": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"assigned": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_assignee": {
"type": "boolean"
},
"is_self_assigned": {
"type": "boolean"
},
"decide": {
"required": [
"decision",
"done",
"can"
],
"type": "object",
"properties": {
"decision": {
"enum": [
"None",
"Awaiting",
"Accepted",
"Declined"
],
"type": "string"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"select": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"selected_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"slots": {
"type": "array",
"items": {
"required": [
"slot_guid",
"from",
"to",
"offset",
"available",
"specific_time_selected",
"start_times"
],
"type": "object",
"properties": {
"slot_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"offset": {
"format": "int32",
"type": "integer"
},
"available": {
"type": "boolean"
},
"specific_time_selected": {
"type": "boolean"
},
"start_times": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
},
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"title": {
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"recipient": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"participants": {
"type": "array",
"items": {
"required": [
"participant_guid",
"is_sender",
"is_recipient",
"is_assignee",
"display_name",
"first_name",
"last_name",
"email_address",
"avatar",
"initials"
],
"type": "object",
"properties": {
"participant_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"is_assignee": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"avatar": {
"type": "string"
},
"initials": {
"type": "string"
}
}
}
},
"created": {
"format": "date-time",
"type": "string"
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"comments": {
"type": "array",
"items": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"is_sender": {
"type": "boolean"
},
"is_recipient": {
"type": "boolean"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attach": {
"required": [
"count",
"remaining",
"max",
"min",
"done",
"can"
],
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"remaining": {
"format": "int32",
"type": "integer"
},
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"attachments": {
"type": "array",
"items": {
"required": [
"attachment_id",
"document_id",
"file_name",
"file_core",
"file_ext",
"mime_type",
"length",
"user_id"
],
"type": "object",
"properties": {
"attachment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"document_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"file_name": {
"type": "string"
},
"file_core": {
"type": "string"
},
"file_ext": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"length": {
"format": "int32",
"type": "integer"
},
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
},
"assignable": {
"type": "boolean"
},
"is_personal": {
"type": "boolean"
},
"is_visible_to_team": {
"type": "boolean"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | EventPromptResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_ReadResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"id",
"prompt_id",
"prompt_type",
"read",
"reader",
"meta",
"comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"prompt_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"prompt_type": {
"enum": [
"None",
"Chat",
"Task",
"Quote",
"Event"
],
"type": "string"
},
"read": {
"format": "date-time",
"type": "string"
},
"reader": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": "[Circular]"
}
}
}
},
"comment": {
"required": [
"comment_id",
"text",
"type",
"created",
"sender",
"is_sender",
"is_target",
"meta"
],
"type": "object",
"properties": {
"comment_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"Chat",
"Complete",
"SuggestComplete",
"Reopen",
"Acknowledge",
"Nudge",
"Accept",
"Decline",
"SelectSlot",
"UpdateSlot",
"Cancel",
"Uncancel",
"Pause",
"Unpause",
"Quick",
"SelectNone",
"Archive",
"Unarchive",
"UpdateAmount",
"Question",
"Addition",
"Answer",
"UndecidedEvent",
"UndecidedQuote",
"UpcomingEvent",
"SeedOfMine",
"SeedOfTheirs",
"AutoUnpause",
"UnacknowledgedTask",
"InactiveTask",
"Attach",
"AttachMany",
"NewTask",
"NewChat",
"NewEvent",
"NewQuote",
"Seed",
"SeenByAssignee",
"Assigned",
"Unassign",
"TaskNotAssigned"
],
"type": "string"
},
"created": {
"format": "date-time",
"type": "string"
},
"sender": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"target": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"is_sender": {
"type": "boolean"
},
"is_target": {
"type": "boolean"
},
"meta": {
"required": [
"id",
"version",
"importance",
"stacked_status",
"quick_responses",
"read",
"archive",
"cancel",
"pause",
"last_updated",
"question",
"edit",
"tags",
"props",
"has_supportive_info",
"has_action",
"card_comment"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"version": {
"format": "int64",
"type": "integer"
},
"importance": {
"enum": [
"none",
"primary",
"secondary",
"tertiary"
],
"type": "string"
},
"stacked_status": {
"required": [
"color_group"
],
"type": "object",
"properties": {
"outstanding_comments": {
"enum": [
"None",
"Single",
"Many"
],
"type": "string"
},
"transient_state": {
"enum": [
"None",
"QuestionedQuizmaster",
"QuestionedContestant",
"Paused",
"TaskSuggestedCompleteSender",
"TaskSuggestedCompleteRecipient",
"EventDeclinedSender",
"EventDeclinedRecipient",
"Nudged",
"TaskProposedSender",
"TaskProposedRecipient",
"EventActiveSender",
"EventActiveRecipient",
"QuoteActiveSender",
"QuoteActiveRecipient",
"EventProposedSender",
"EventProposedRecipient",
"QuoteProposedSender",
"QuoteProposedRecipient",
"TaskActive",
"TaskUnread",
"NoteUnread",
"NoteActive",
"TaskUnassigned"
],
"type": "string"
},
"terminal_state": {
"enum": [
"None",
"Cancelled",
"QuoteAccepted",
"QuoteRejected",
"EventAccepted",
"TaskCompleted",
"Archived"
],
"type": "string"
},
"color_group": {
"enum": [
"None",
"New",
"Active",
"Cancelled",
"Archived"
],
"type": "string"
}
}
},
"quick_responses": {
"enum": [
"None",
"EventSlotSelected",
"QuoteAccepted",
"TaskCompleted",
"EventReceived",
"QuoteReceived",
"ChatReceived",
"InactiveTask",
"TaskCreated",
"AssigneeChanged",
"TaskNotAssigned"
],
"type": "string"
},
"read": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"archive": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"cancel": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"pause": {
"required": [
"can_undo",
"done",
"can"
],
"type": "object",
"properties": {
"can_undo": {
"type": "boolean"
},
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"last_updated": {
"format": "date-time",
"type": "string"
},
"question": {
"required": [
"active",
"assigned"
],
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"assigned": {
"type": "boolean"
},
"by": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"edit": {
"required": [
"done",
"can"
],
"type": "object",
"properties": {
"done": {
"type": "boolean"
},
"date": {
"format": "date-time",
"type": "string"
},
"can": {
"type": "boolean"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"props": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"has_supportive_info": {
"type": "boolean"
},
"has_action": {
"type": "boolean"
},
"card_comment": "[Circular]"
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | ReadResponse | false | none | none |
| error | IServiceError | false | none | none |
ILegacyServiceResponse_UserProfileResponse_ErrorResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"first_name",
"last_name",
"email_address",
"account_name",
"account_description",
"about",
"initials",
"avatar",
"bot_version",
"team_role"
],
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email_address": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_description": {
"type": "string"
},
"about": {
"type": "string"
},
"initials": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"bot_version": {
"format": "int32",
"type": "integer"
},
"team_role": {
"type": "string"
}
}
},
"error": {
"required": [
"http_status_code",
"error_code"
],
"type": "object",
"properties": {
"http_status_code": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string"
},
"error_code": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | UserProfileResponse | false | none | none |
| error | ErrorResponse | false | none | none |
IServiceResponse_TeamResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"members"
],
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"required": [
"user_id",
"account_id",
"email_address",
"first_name",
"last_name",
"avatar",
"invitation_pending",
"roles"
],
"type": "object",
"properties": {
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"account_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"email_address": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"invitation_pending": {
"type": "boolean"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | TeamResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_TeamInviteResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"user_guid",
"account_guid"
],
"type": "object",
"properties": {
"user_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"account_guid": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | TeamInviteResponse | false | none | none |
| error | IServiceError | false | none | none |
IServiceResponse_TeamMemberResponse_
{
"type": "object",
"properties": {
"result": {
"required": [
"user_id",
"account_id",
"email_address",
"first_name",
"last_name",
"avatar",
"invitation_pending",
"roles"
],
"type": "object",
"properties": {
"user_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"account_id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"email_address": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"avatar": {
"required": [
"default",
"24",
"40",
"56",
"60",
"80",
"120"
],
"type": "object",
"properties": {
"24": {
"type": "string"
},
"40": {
"type": "string"
},
"56": {
"type": "string"
},
"60": {
"type": "string"
},
"80": {
"type": "string"
},
"120": {
"type": "string"
},
"default": {
"type": "string"
}
}
},
"invitation_pending": {
"type": "boolean"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"error": {
"required": [
"StatusCode",
"ErrorCode",
"Messages"
],
"type": "object",
"properties": {
"StatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"type": "string",
"readOnly": true
},
"ErrorCode": {
"type": "string",
"readOnly": true
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | TeamMemberResponse | false | none | none |
| error | IServiceError | false | none | none |
JS SDK
We offer a simple JS SDK that can be included in your web application.

Simply drop the following code into your web application, just before the </body> tag:
<link rel='stylesheet' href='${path-to-sdk}/getbusy.css' /><script type="text/javascript" src='${path-to-sdk}/getbusy.min.js'></script>
This will add window.GetBusy - now simply initialise by calling the init method as below:
GetBusy.init({config});
The config object supports the following properties:
mountingElement- the DOM node to mount the app topersist- boolean - indicates if the open/closed state of the iframe should be maintained between page refreshesposition- object{top: int, bottom: int, left: int, right: int}- indicates the preferred position of the iframe / iframe trigger
GetBusy.showCreateConnection({connection});
The connection object supports the following properties:
first- The first name of the connectionlast- The last name of the connectionemail- The email of the connection
GetBusy.createTaskWithDocument({docAttachRequest});
The docAttachRequest object supports the following properties:
contact- seeconnectionabovedocUrl- The URL where the web app can retrieve the document to be attachedtitle- The title of the created to-dodesc- The extra info to be included with the to-dotype- Only valid option is 'Task
Hyperlink API
The application supports a simple hyperlink API with the following endpoints:
Create a connection
https://test.dev.getbusy.com/api/contact/create?email={EmailAddress}&first={FirstName}&last={LastName}
Replace {EmailAddress}, {FirstName} and {LastName} with url encoded values.
Create a todo thread
https://test.dev.getbusy.com/api/todo/create?title={Title}&desc={Description}&contact.email={EmailAddress}&contact.first={FirstName}&contact.last={LastName}&type=task
Replace {Title}, {Description}, {EmailAddress}, {FirstName} and {LastName} with url encoded values.