Warning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/": { "get": { "tags": [ "AiAgents" ], "summary": "Gets the details of an AI agent.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/ai-agents/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "AiAgents" ], "summary": "Updates an AI agent.", "description": "Rate limit: Up to 10 requests in a 15 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAIAgentModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAIAgentModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAIAgentModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/ai-agents/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "AiAgents" ], "summary": "Deletes an AI agent.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/ai-agents/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/profile-picture/": { "put": { "tags": [ "AiAgents" ], "summary": "Allows to update the profile picture of an AI agent.", "description": "Rate limit: Up to 10 requests in a 15 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "type": "object", "properties": { "image": { "type": "string", "description": "The new photo", "format": "binary" } } }, "encoding": { "image": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "uri", "example": "https://example.com" } }, "text/json": { "schema": { "type": "string", "format": "uri", "example": "https://example.com" } }, "text/plain": { "schema": { "type": "string", "format": "uri", "example": "https://example.com" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/ai-agents/{id}/profile-picture/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/ingest/": { "post": { "tags": [ "AiAgents" ], "summary": "Commits the changes made to the training data of an AI agent.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "operationId": "IngestAgent", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/{id}/ingest/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/knowledge-bases/{kbId}/ingest-kb/": { "post": { "tags": [ "AiAgents" ], "summary": "Commits the changes made to a specific knowledge base.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "operationId": "IngestKnowledgeBase", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/knowledge-bases/{kbId}/ingest-kb/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/knowledge-bases/": { "post": { "tags": [ "AiAgents" ], "summary": "Creates a new knowledge base for the organization", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateKnowledgeBaseRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateKnowledgeBaseRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateKnowledgeBaseRequestModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/knowledge-bases/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "get": { "tags": [ "AiAgents" ], "summary": "Gets a list of knowledge bases for the organization", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/ai-agents/knowledge-bases/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/voices/": { "get": { "tags": [ "AiAgents" ], "summary": "Gets a list of available voices to be used in an agent", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentVoiceModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentVoiceModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentVoiceModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/ai-agents/voices/\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/pre-trained-sectors/": { "get": { "tags": [ "AiAgents" ], "summary": "Gets a list of pre-trained sectors and their agent function templates", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentPreTrainedSectorModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentPreTrainedSectorModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentPreTrainedSectorModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/ai-agents/pre-trained-sectors/\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/clone-knowledge-base/": { "put": { "tags": [ "AiAgents" ], "summary": "Accepts two agent Ids and clones the knowledge base from one to the other.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CloneKnowledgeBaseModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CloneKnowledgeBaseModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CloneKnowledgeBaseModel" } ] } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/ai-agents/clone-knowledge-base/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/import-qas-from-chats/": { "post": { "tags": [ "AiAgents" ], "summary": "POST Ai-Agents", "description": "Rate limit: Up to 10 requests in a 15 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateQAsFromChatsModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateQAsFromChatsModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateQAsFromChatsModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FullAITalkAgentModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/{id}/import-qas-from-chats/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/qa/": { "get": { "tags": [ "AiAgents" ], "summary": "Gets the Q&As of an AI agent.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "query", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "kbId", "in": "query", "description": "Optional knowledge base ID to filter results", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentQAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentQAModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentQAModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/ai-agents/{id}/qa/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&query=''&kbId=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "AiAgents" ], "summary": "Creates a Q&A for an AI agent.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentQAModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentQAModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentQAModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/{id}/qa/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/qa/{qaId}/": { "delete": { "tags": [ "AiAgents" ], "summary": "Deletes a Q&A for an AI agent.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "qaId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/ai-agents/{id}/qa/{qaId}/?organizationId='AB_12-xyzEXAMPLE'&kbId=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/qa/file/": { "post": { "tags": [ "AiAgents" ], "summary": "Creates Q&As for an AI agent from a file.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "The file containing the Q&As. Currently supports CSV, XLS, and XLSX", "format": "binary" } } }, "encoding": { "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentQAModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentQAModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentQAModel" } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/{id}/qa/file/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/website-crawlers/": { "get": { "tags": [ "AiAgents" ], "summary": "Gets website crawler registrations of an AI agent training data.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "query", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "kbId", "in": "query", "description": "Optional knowledge base ID to filter results", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfWebsiteCrawlerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfWebsiteCrawlerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfWebsiteCrawlerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/ai-agents/{id}/website-crawlers/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&query=''&kbId=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "AiAgents" ], "summary": "Creates a website crawler registration for an AI agent training data.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentWebsiteCrawlerModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentWebsiteCrawlerModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentWebsiteCrawlerModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/{id}/website-crawlers/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/website-crawlers/{crawlerId}/": { "delete": { "tags": [ "AiAgents" ], "summary": "Deletes a website crawler registration from an AI agent training data.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "crawlerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/ai-agents/{id}/website-crawlers/{crawlerId}/?organizationId='AB_12-xyzEXAMPLE'&kbId=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/documents/": { "post": { "tags": [ "AiAgents" ], "summary": "Adds a new document to an AI agent training data.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Document", "OrganizationId" ], "type": "object", "properties": { "OrganizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "Document": { "type": "string", "format": "binary" }, "KbId": { "type": "string" } } }, "encoding": { "OrganizationId": { "style": "form" }, "Document": { "style": "form" }, "KbId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDocumentModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDocumentModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDocumentModel" } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/ai-agents/{id}/documents/\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "get": { "tags": [ "AiAgents" ], "summary": "Gets the documents of an AI agent training data.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "query", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "kbId", "in": "query", "description": "Optional knowledge base ID to filter results", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentDocumentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentDocumentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentDocumentModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/ai-agents/{id}/documents/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&query=''&kbId=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/ai-agents/{id}/documents/{documentId}/": { "delete": { "tags": [ "AiAgents" ], "summary": "Deletes a document from an AI agent training data.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the agent", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "documentId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentDocumentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAgentDocumentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AIAgentDocumentModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/ai-agents/{id}/documents/{documentId}/?organizationId='AB_12-xyzEXAMPLE'&kbId=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/": { "get": { "tags": [ "Bots" ], "summary": "Gets a paginated list of all the bots of all types of one organization. Optionally filtering by a single channel", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "channelId", "in": "query", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "OrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/BotProperty" } ] } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "groupIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBotBaseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBotBaseModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfBotBaseModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/?organizationId='AB_12-xyzEXAMPLE'&channelId='AB_12-xyzEXAMPLE'&OrderBy=''&Order=''&query=''&Skip=''&Take=''&Behavior=''&groupIds=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/{id}/": { "get": { "tags": [ "Bots" ], "summary": "Gets a single bot of any type", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Bots" ], "summary": "Deletes a bot of any type then returns it", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/bots/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Bots" ], "summary": "PUT Bots", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotModel" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotBaseWrapperModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/bots/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/{id}/bindings/": { "get": { "tags": [ "Bots" ], "summary": "Returns all places where a bot is referenced/bound", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotBindingsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotBindingsModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotBindingsModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/{id}/bindings/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/reorder/": { "put": { "tags": [ "Bots" ], "summary": "PUT Bots", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "$ref": "#/components/schemas/TaggingBotModel" }, { "$ref": "#/components/schemas/SectorForwardingBotModel" }, { "$ref": "#/components/schemas/GreetingBotModel" }, { "$ref": "#/components/schemas/FlowchartBotModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "$ref": "#/components/schemas/TaggingBotModel" }, { "$ref": "#/components/schemas/SectorForwardingBotModel" }, { "$ref": "#/components/schemas/GreetingBotModel" }, { "$ref": "#/components/schemas/FlowchartBotModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "$ref": "#/components/schemas/TaggingBotModel" }, { "$ref": "#/components/schemas/SectorForwardingBotModel" }, { "$ref": "#/components/schemas/GreetingBotModel" }, { "$ref": "#/components/schemas/FlowchartBotModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/bots/reorder/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/snapshot/{snapshotId}/": { "get": { "tags": [ "Bots" ], "summary": "Gets a specific bot snapshot by its ID", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "snapshotId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotSnapshotModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotSnapshotModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotSnapshotModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/snapshot/{snapshotId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Bots" ], "summary": "Update snapshot title.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "snapshotId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotSnapshotModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotSnapshotModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotSnapshotModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotSnapshotModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotSnapshotModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotSnapshotModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/bots/snapshot/{snapshotId}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/snapshots/": { "get": { "tags": [ "Bots" ], "summary": "Lists bot snapshots by bot id", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "botId", "in": "query", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBotSnapshotModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBotSnapshotModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfBotSnapshotModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/snapshots/?organizationId='AB_12-xyzEXAMPLE'&botId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/flowchart/": { "get": { "tags": [ "Bots" ], "summary": "Gets a paginated list of all the chatbots of type flowchart", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartBotModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartBotModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartBotModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/flowchart/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Bots" ], "summary": "POST Bots", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowchartBotModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowchartBotModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FlowchartBotModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/bots/flowchart/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/flowchart/botinstances/": { "get": { "tags": [ "Bots" ], "summary": "Gets a paginated list of all the chatbots of type flowchart", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "botId", "in": "query", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "startUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartBotInstanceModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartBotInstanceModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartBotInstanceModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/flowchart/botinstances/?organizationId='AB_12-xyzEXAMPLE'&botId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&startUTC=''&endUTC=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/flowchart/{botId}/botinstances/{botInstanceId}/": { "get": { "tags": [ "Bots" ], "summary": "Gets a paginated list of all the chatbots of type flowchart", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "botId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "botInstanceId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowchartBotInstanceModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowchartBotInstanceModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FlowchartBotInstanceModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/flowchart/{botId}/botinstances/{botInstanceId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/flowchart/{botId}/botinstances/botsnapshots/{botSnapshotId}/": { "get": { "tags": [ "Bots" ], "summary": "GET Bots", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "botId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "botSnapshotId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowchartBotInstanceModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowchartBotInstanceModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FlowchartBotInstanceModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/flowchart/{botId}/botinstances/botsnapshots/{botSnapshotId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/flowchart/manual-starts/": { "get": { "tags": [ "Bots" ], "summary": "Gets a paginated list of all the manual start steps", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "query", "in": "query", "description": "Filter by bot title or trigger name", "schema": { "type": "string" } }, { "name": "hidden", "in": "query", "description": "Filter by hidden status. When null, returns all", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartManualStartStep" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartManualStartStep" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfFlowchartManualStartStep" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bots/flowchart/manual-starts/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&query=''&hidden=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bots/flowchart/{id}/": { "put": { "tags": [ "Bots" ], "summary": "PUT Bots", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditFlowchartBotModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditFlowchartBotModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditFlowchartBotModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowchartBotModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowchartBotModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FlowchartBotModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/bots/flowchart/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bulk-send-session/": { "post": { "tags": [ "BulkSendSession" ], "summary": "POST Bulk-Send-Session", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBulkSendSessionModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBulkSendSessionModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBulkSendSessionModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicBulkSendSessionModel" }, { "$ref": "#/components/schemas/BulkSendSessionModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicBulkSendSessionModel" }, { "$ref": "#/components/schemas/BulkSendSessionModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicBulkSendSessionModel" }, { "$ref": "#/components/schemas/BulkSendSessionModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/bulk-send-session/\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "get": { "tags": [ "BulkSendSession" ], "summary": "GET Bulk-Send-Session", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "OrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkSendProperty" } ] } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "queryString", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicBulkSendSessionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicBulkSendSessionModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicBulkSendSessionModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bulk-send-session/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&OrderBy=''&Order=''&queryString=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bulk-send-session/{id}/": { "get": { "tags": [ "BulkSendSession" ], "summary": "GET Bulk-Send-Session", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSendSessionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkSendSessionModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BulkSendSessionModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bulk-send-session/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bulk-send-session/{id}/scheduled/": { "get": { "tags": [ "BulkSendSession" ], "summary": "GET Bulk-Send-Session", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "Status.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Status.Values", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledMessageStatus" } } }, { "name": "MessageState.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "MessageState.Values", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageStates" } } }, { "name": "BotStatus.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "BotStatus.Values", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BotStatus" } } }, { "name": "BotStopReason.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "BotStopReason.Values", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BotStopReason" } } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBulkSendScheduleModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBulkSendScheduleModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfBulkSendScheduleModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bulk-send-session/{id}/scheduled/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&Order=''&Status.Rule=''&Status.Values=''&MessageState.Rule=''&MessageState.Values=''&BotStatus.Rule=''&BotStatus.Values=''&BotStopReason.Rule=''&BotStopReason.Values=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bulk-send-session/{id}/messages-sent/": { "get": { "tags": [ "BulkSendSession" ], "summary": "GET Bulk-Send-Session", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBulkSendMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBulkSendMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfBulkSendMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/bulk-send-session/{id}/messages-sent/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&order=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/channels/{id}/": { "get": { "tags": [ "Channels" ], "summary": "Get more information of a channel", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the channel", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/channels/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Channels" ], "summary": "This route allows editing some information of an existing channel", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the channel to edit", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChannelModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChannelModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChannelModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/channels/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Channels" ], "summary": "Attempts to delete an existing Channel. Note that not all combinations of channel types and states can be deleted by this action. If yours is such case, please contact support", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the channel", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "reason", "in": "query", "description": "Reason for deleting the channel", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/channels/{id}/?organizationId='AB_12-xyzEXAMPLE'&reason=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/channels/": { "get": { "tags": [ "Channels" ], "summary": "Get basic information on all channels of the organization", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWelcomerChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationMembersChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWebsiteWidgetChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel" } ] } } }, "text/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWelcomerChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationMembersChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWebsiteWidgetChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel" } ] } } }, "text/plain": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWelcomerChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationMembersChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWebsiteWidgetChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel" } ] } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/channels/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/channels/starter/": { "post": { "tags": [ "Channels" ], "summary": "Creates a new Starter channel. This one can be used right away after created, you just need to retrieve its synchronization QRCode with the \"QRCode\" action and scan it.", "description": "Rate limit: Up to 10 requests in a 15 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateStarterChannelModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateStarterChannelModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateStarterChannelModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/channels/starter/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/channels/waba/": { "post": { "tags": [ "Channels" ], "summary": "Creates a request for a Business channel. Do note that these cannot be created automatically, you will need to reach out to support with the created Id and follow their instructions to activate the channel.\nFor this reason, and the lack of context for each necessary information, it is recommended that you create the channel using our existing form", "description": "Rate limit: Up to 10 requests in a 15 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateWabaChannelModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateWabaChannelModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateWabaChannelModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/channels/waba/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/channels/{id}/groups/": { "post": { "tags": [ "Channels" ], "summary": "Adds one or more group IDs to the channel", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the channel to edit", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "$ref": "#/components/schemas/WelcomerChannelModel" }, { "$ref": "#/components/schemas/MembersChannelModel" }, { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "$ref": "#/components/schemas/PhoneNumberChannelBaseModel" }, { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "$ref": "#/components/schemas/BrokerWhatsappChannelModel" }, { "$ref": "#/components/schemas/GupshupWhatsappChannelModel" }, { "$ref": "#/components/schemas/CloudAPIWhatsappChannelModel" }, { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "$ref": "#/components/schemas/GupshupInstagramChannelModel" }, { "$ref": "#/components/schemas/WebsiteWidgetChannelModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/channels/{id}/groups/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/": { "get": { "tags": [ "Chats" ], "summary": "Gets basic info of all chats", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Sectors.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Sectors.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "PhoneNumbers", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Searchtext", "in": "query", "schema": { "type": "string" } }, { "name": "RelativeStartFromEventUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "RelativeTakeDirection", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/TakeDirection" } ] } }, { "name": "Type", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterTypes" } ] } }, { "name": "ChatState", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatState" } ], "default": "Open" } }, { "name": "ContactTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactType" } } }, { "name": "LastMessage", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/LastMessage" } ], "default": "All" } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ], "default": "Desc" } }, { "name": "ChatOrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatOrderBy" } ], "default": "LastMessage" } }, { "name": "DateStartCreatedAtUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateEndCreatedAtUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IncludePinneds", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "Visibility", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatVisibility" } } }, { "name": "Messages", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ReadState" } ], "default": "All" } }, { "name": "Participants.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Participants.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "Tags.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Tags.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "Members.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Members.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "Channels.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Channels.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/chats/?organizationId='AB_12-xyzEXAMPLE'&Sectors.Rule=''&Sectors.Values=''&PhoneNumbers=''&Searchtext=''&RelativeStartFromEventUTC=''&RelativeTakeDirection=''&Type=''&ChatState=''&ContactTypes=''&LastMessage=''&Order=''&ChatOrderBy=''&DateStartCreatedAtUTC=''&DateEndCreatedAtUTC=''&IncludePinneds=''&Visibility=''&Messages=''&Participants.Rule=''&Participants.Values=''&Tags.Rule=''&Tags.Values=''&Members.Rule=''&Members.Values=''&Channels.Rule=''&Channels.Values=''&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Chats" ], "summary": "Creates a new chat for a contact in a channel. If there's already a chat open with this contact and this channel, it will be returned and nothing will be created", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateChatModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateChatModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateChatModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/chats/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/pinned/": { "get": { "tags": [ "Chats" ], "summary": "Gets all pinned chats", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinnedChatsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PinnedChatsModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PinnedChatsModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/chats/pinned/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/": { "get": { "tags": [ "Chats" ], "summary": "Gets all the details of a single chat", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the chat to get", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "includeMessages", "in": "query", "description": "How many messages to include in the LatestMessages array", "schema": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/chats/{id}/?organizationId='AB_12-xyzEXAMPLE'&includeMessages=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Chats" ], "summary": "Allows updating bunch of options and states of a chat, like closing, marking as private, assigning it to another member and/or sector etc.", "description": "Rate limit: Up to 250 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the chat to update", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChatModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChatModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChatModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/chats/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Chats" ], "summary": "DELETE Chats", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/chats/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{chatId}/relative-messages/": { "get": { "tags": [ "Chats" ], "summary": "Gets messages from anywhere in a chat based in the desired start date", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "chatId", "in": "path", "description": "Id of the chat to search the messages in", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "FromEventUTC", "in": "query", "description": "Starting point to get the messages", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "Take", "in": "query", "description": "How many messages to take after or before the specified date", "required": true, "schema": { "maximum": 250, "minimum": 1, "type": "integer", "format": "int32", "default": 50 } }, { "name": "Direction", "in": "query", "description": "In which direction to get the messages from the start date", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/TakeDirection" } ], "default": "TakeBefore" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelativeMessagesResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RelativeMessagesResponseModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RelativeMessagesResponseModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/chats/{chatId}/relative-messages/?organizationId='AB_12-xyzEXAMPLE'&FromEventUTC=''&Take=''&Direction=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/dm/{id}/": { "get": { "tags": [ "Chats" ], "summary": "Get or Create a new dm chat. It can be used between organization members.", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/chats/dm/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/internal/": { "post": { "tags": [ "Chats" ], "summary": "Creates a new internal chat for contacts of type `ContactType.MemberGroup`.\nIf the contact does not exist, a new contact is created and a new internal chat is established.", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "requestBody": { "description": "The model containing the `ContactName` used to find or create the contact.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateMembersChatModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateMembersChatModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateMembersChatModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/chats/internal/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/internal/contact-id/": { "post": { "tags": [ "Chats" ], "summary": "Creates a new internal chat for an existing contact of type `ContactType.MemberGroup` identified by `ContactId`/>.\nIf the user does not have administrative permissions, returns the most recent closed chat for the contact.\nOtherwise, creates a new internal chat for the contact.", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "requestBody": { "description": "The model containing the `ContactId` used to find the contact.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateMembersChatByContactIdModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateMembersChatByContactIdModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateMembersChatByContactIdModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/chats/internal/contact-id/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/read/": { "put": { "tags": [ "Chats" ], "summary": "If the contact type is Umbler.UTalk.Core.Domain.ContactType.DirectMessage or Umbler.UTalk.Core.Domain.ContactType.Group, \nmarks the desired chat as having its last message with an Read state. Chat must have at least one message for it to work.\n \nIf the contact type is Umbler.UTalk.Core.Domain.ContactType.MemberDirectMessage or Umbler.UTalk.Core.Domain.ContactType.MemberGroup, \nit resets the unread counter for the current member and notifies them.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the chat to mark as Read", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/chats/{id}/read/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/unread/": { "put": { "tags": [ "Chats" ], "summary": "Marks the chat as unread.\n- For DirectMessage and Group, marks the desired chat as having its last message with an Unread state. Chat must have at least one message for it to work.\n- For MemberDirectMessage or MemberGroup, sets the member's unread count to 1 if it's currently zero.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the chat to mark as unread", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/chats/{id}/unread/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/start-bot/": { "post": { "tags": [ "Chats" ], "summary": "POST Chats", "description": "Rate limit: Up to 120 requests in a 1 minute window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatbotModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatbotModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatbotModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/chats/start-bot/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/credit-conversation/": { "get": { "tags": [ "Chats" ], "summary": "Get all messages conversation window from this chat.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The id of the Conversation", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditConversationModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditConversationModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditConversationModel" } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/chats/{id}/credit-conversation/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/pin/": { "put": { "tags": [ "Chats" ], "summary": "Pin a message to the top of the list.\nThis is individual. The pinned conversations can only be seen by you.\nMax of 3 pinned messages.", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The id of the Conversation", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "pin", "in": "query", "description": "If true, pin chat; if false, unpin", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/chats/{id}/pin/?organizationId='AB_12-xyzEXAMPLE'&pin=''\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/basic-info/": { "get": { "tags": [ "Chats" ], "summary": "GET Chats", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "StartDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ChannelId", "in": "query", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "ChatState", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatState" } ] } }, { "name": "Searchtext", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/chats/basic-info/?organizationId='AB_12-xyzEXAMPLE'&StartDate=''&EndDate=''&ChannelId='AB_12-xyzEXAMPLE'&ChatState=''&Searchtext=''&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/favorite-messages/": { "get": { "tags": [ "Chats" ], "summary": "Gets all the favorite messages of a single chat", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the current chat", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } }, "text/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } }, "text/plain": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/chats/{id}/favorite-messages/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/tags/": { "post": { "tags": [ "ChatTags" ], "summary": "Adds a tag to an existing chat. This entire feature supposed to be removed in the near future and replaced only with the contact's tags", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/chats/{id}/tags/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/tags/{tagId}/": { "delete": { "tags": [ "ChatTags" ], "summary": "Removes a tag of an existing chat. This entire feature supposed to be removed in the near future and replaced only with the contact's tags", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/chats/{id}/tags/{tagId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/chats/{id}/tags/list/": { "post": { "tags": [ "ChatTags" ], "summary": "Add a list of tags to a chat.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/chats/{id}/tags/list/\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "ChatTags" ], "summary": "Delete a list of tags to a chat.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ChatModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/chats/{id}/tags/list/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contact-ratings/": { "get": { "tags": [ "ContactRatings" ], "summary": "Paginated list of all ratings in the organization. Filterable by repository and date range.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "startUTC", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "endUTC", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "onlyRepositories", "in": "query", "description": "Filter by repository names. All possibilities can be obtained by the GET repositories route in this group", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "OrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactRatingProperty" } ] } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "channelId", "in": "query", "description": "The identifier of the channel used to filter the contact ratings.", "schema": { "type": "string" } }, { "name": "botId", "in": "query", "description": "The unique identifier of the bot.", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfContactRatingsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfContactRatingsModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfContactRatingsModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contact-ratings/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&startUTC=''&endUTC=''&onlyRepositories=''&OrderBy=''&Order=''&channelId=''&botId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contact-ratings/simplified/": { "get": { "tags": [ "ContactRatings" ], "summary": "Non-paginated, simplified list of all ratings in the organization. Filterable by repository and date range.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "startUTC", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "endUTC", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "onlyRepositories", "in": "query", "description": "Filter by repository names. All possibilities can be obtained by the GET repositories route in this group", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "channelId", "in": "query", "description": "The identifier of the channel used to filter the contact ratings.", "schema": { "type": "string" } }, { "name": "botId", "in": "query", "description": "The unique identifier of the bot.", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRatingSimplifiedModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRatingSimplifiedModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRatingSimplifiedModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contact-ratings/simplified/?organizationId='AB_12-xyzEXAMPLE'&startUTC=''&endUTC=''&onlyRepositories=''&channelId=''&botId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contact-ratings/repositories/": { "get": { "tags": [ "ContactRatings" ], "summary": "Gets all unique repository names that have ratings. Useful to know what can be used as a filter for the routes that list the ratings.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contact-ratings/repositories/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contact-ratings/by-chat/{chatId}/": { "get": { "tags": [ "ContactRatings" ], "summary": "Gets all the ratings given to a specific chat", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "chatId", "in": "path", "description": "The chat id", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRatingsModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRatingsModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRatingsModel" } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contact-ratings/by-chat/{chatId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/chats/": { "get": { "tags": [ "Contacts" ], "summary": "Gets a paginated list of current and past chats that belong to the selected contact", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact to get the chats from", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "ChatState", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatState" } ], "default": "All" } }, { "name": "RelativeStartFromEventUTC", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "RelativeTakeDirection", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/TakeDirection" } ] } }, { "name": "Tags.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Tags.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "Members.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Members.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "Channels.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Channels.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfBasicChatModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/{id}/chats/?organizationId='AB_12-xyzEXAMPLE'&ChatState=''&RelativeStartFromEventUTC=''&RelativeTakeDirection=''&Tags.Rule=''&Tags.Values=''&Members.Rule=''&Members.Values=''&Channels.Rule=''&Channels.Values=''&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/": { "get": { "tags": [ "Contacts" ], "summary": "Gets a paginated list of all contacts in the organization, with optional filters", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "QueryString", "in": "query", "schema": { "type": "string" } }, { "name": "Tags.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Tags.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "CustomFields", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactState" } ] } }, { "name": "OrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactProperty" } ] } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "includeGroups", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleContactModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&QueryString=''&Tags.Rule=''&Tags.Values=''&CustomFields=''&State=''&OrderBy=''&Order=''&includeGroups=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Contacts" ], "summary": "Creates a new contact in the selected organization.", "description": "Rate limit: Up to 250 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateContactModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateContactModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateContactModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactSaveModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactSaveModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactSaveModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/contacts/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/member-groups/": { "get": { "tags": [ "Contacts" ], "summary": "Gets a paginated list of contacts whose `ContactType` is Umbler.UTalk.Core.Domain.ContactType.MemberGroup, \napplying optional filters such as search query and tags.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "QueryString", "in": "query", "schema": { "type": "string" } }, { "name": "Tags.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Tags.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "OrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/MemberGroupContactsProperty" } ] } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleContactModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/member-groups/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&QueryString=''&Tags.Rule=''&Tags.Values=''&OrderBy=''&Order=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/": { "get": { "tags": [ "Contacts" ], "summary": "Gets all details of a single contact", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Contacts" ], "summary": "Allows to update some information associated to an existing contact", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact to update", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateContactModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateContactModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateContactModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/contacts/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Contacts" ], "summary": "Deletes a contact. You have the option of either closing their open chats or deleting all of them.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The id of the contact to delete", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "chatAction", "in": "query", "description": "What to do with this contact's chats", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/DeleteContactChatAction" } ], "default": "Close" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/contacts/{id}/?organizationId='AB_12-xyzEXAMPLE'&chatAction=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/profile/": { "get": { "tags": [ "Contacts" ], "summary": "Gets the most basic information about the contact", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/{id}/profile/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/phone/": { "get": { "tags": [ "Contacts" ], "summary": "Gets a contact by its phone number", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "phoneNumber", "in": "query", "description": "The phone number to search", "required": true, "schema": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/phone/?organizationId='AB_12-xyzEXAMPLE'&phoneNumber='+5511987654321'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/blocked/": { "put": { "tags": [ "Contacts" ], "summary": "Updates the blocked status of a contact. A blocked contact cannot send messages to your organization", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the user to block or unblock", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "isBlocked", "in": "query", "description": "Sets the desired block state", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/contacts/{id}/blocked/?organizationId='AB_12-xyzEXAMPLE'&isBlocked=''\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/notes/": { "get": { "tags": [ "Contacts" ], "summary": "Get all notes from a contact.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The id of the contact to add the note to", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteModel" } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/{id}/notes/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Contacts" ], "summary": "Allows adding a note to an existing contact that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The id of the contact to add the note to", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateNoteModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateNoteModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateNoteModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/contacts/{id}/notes/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/notes/{noteId}/": { "delete": { "tags": [ "Contacts" ], "summary": "Deletes a note attached to a contact by its Id", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact that contains the note", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "noteId", "in": "path", "description": "The Id of the note to delete", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/contacts/{id}/notes/{noteId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/notes/{noteId}/pin/": { "put": { "tags": [ "Contacts" ], "summary": "Pins or unpins a specific note for a given contact.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact.", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "noteId", "in": "path", "description": "The Id of the note to pin or unpin.", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "pin", "in": "query", "description": "If true, the note will be pinned; if false, it will be unpinned.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ContactModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/contacts/{id}/notes/{noteId}/pin/?organizationId='AB_12-xyzEXAMPLE'&pin=''\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/note/{noteId}/": { "get": { "tags": [ "Contacts" ], "summary": "Returns a note by its ID for the given contact.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The ID of the contact.", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "noteId", "in": "path", "description": "The ID of the note.", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NoteModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/NoteModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/{id}/note/{noteId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/custom-fields/": { "get": { "tags": [ "Contacts" ], "summary": "Get all custom fields from a contact.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact to get all the custom fields", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } }, "text/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } }, "text/plain": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/{id}/custom-fields/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Contacts" ], "summary": "Allows adding a custom field to an existing contact that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the contact to add the custom field to", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactListStringCustomFieldModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactListStringCustomFieldModel" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactListStringCustomFieldModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/contacts/{id}/custom-fields/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/custom-fields/{customFieldId}/": { "get": { "tags": [ "Contacts" ], "summary": "Get a custom field from a contact by Id.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "customFieldId", "in": "path", "description": "The Id of the custom field or custom field definition to get", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/{id}/custom-fields/{customFieldId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Contacts" ], "summary": "Allows editing a custom field to an existing contact that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact to edit the custom field to", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "customFieldId", "in": "path", "description": "The Id of the custom field or custom field definition to edit", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactListStringCustomFieldModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactListStringCustomFieldModel" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/EditContactListStringCustomFieldModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/contacts/{id}/custom-fields/{customFieldId}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Contacts" ], "summary": "Deletes a custom field to a contact by its Id", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact that contains the custom field", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "customFieldId", "in": "path", "description": "The Id of the custom field or custom field definition to delete", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/contacts/{id}/custom-fields/{customFieldId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/custom-fields/simplified/": { "post": { "tags": [ "Contacts" ], "summary": "Allows adding or editing a simplified custom field to an existing contact that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the contact associated with the custom field.", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "Contains the name of custom field definition, a value for custom field definition and the organization unique identifier", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SimplifiedCustomFieldModel" } ], "description": "Represents a simplified model for a single custom field containing its name and value." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SimplifiedCustomFieldModel" } ], "description": "Represents a simplified model for a single custom field containing its name and value." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SimplifiedCustomFieldModel" } ], "description": "Represents a simplified model for a single custom field containing its name and value." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/contacts/{id}/custom-fields/simplified/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/custom-fields/simplified/batch/": { "post": { "tags": [ "Contacts" ], "summary": "Allows adding or editing a batch of simplified custom fields to an existing contact that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the contact associated with the custom fields.", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "Batch model containing the list of custom field names and values to be added or updated, and the organization unique identifier.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BatchSimplifiedCustomFieldModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BatchSimplifiedCustomFieldModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BatchSimplifiedCustomFieldModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } }, "text/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } }, "text/plain": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/contacts/{id}/custom-fields/simplified/batch/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/custom-field-aggregation/": { "get": { "tags": [ "Contacts" ], "summary": "GET Contacts", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "QueryString", "in": "query", "schema": { "type": "string" } }, { "name": "Tags.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "Tags.Values", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, { "name": "CustomFields", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactState" } ] } }, { "name": "CustomFieldDefinitionId", "in": "query", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "AggregationType", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/AggregationType" } ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldAggregationModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldAggregationModel" }, { "$ref": "#/components/schemas/NumberCustomFieldAggregationModel" }, { "$ref": "#/components/schemas/DateCustomFieldAggregationModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldAggregationModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldAggregationModel" }, { "$ref": "#/components/schemas/NumberCustomFieldAggregationModel" }, { "$ref": "#/components/schemas/DateCustomFieldAggregationModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldAggregationModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldAggregationModel" }, { "$ref": "#/components/schemas/NumberCustomFieldAggregationModel" }, { "$ref": "#/components/schemas/DateCustomFieldAggregationModel" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/contacts/custom-field-aggregation/?organizationId='AB_12-xyzEXAMPLE'&QueryString=''&Tags.Rule=''&Tags.Values=''&CustomFields=''&State=''&CustomFieldDefinitionId='AB_12-xyzEXAMPLE'&AggregationType=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/tags/": { "post": { "tags": [ "ContactTags" ], "summary": "Adds a tag to a contact. The list of tags can later be retrieved using the contact's GET action.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Contact to update", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/contacts/{id}/tags/\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "ContactTags" ], "summary": "Removes a tag from a contact.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the contact", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "tagId", "in": "query", "description": "The Id of the tag", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/contacts/{id}/tags/?organizationId='AB_12-xyzEXAMPLE'&tagId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/contacts/{id}/tags/list/": { "post": { "tags": [ "ContactTags" ], "summary": "Add a list of tags to a contact.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/contacts/{id}/tags/list/\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "ContactTags" ], "summary": "Delete a list of tags to a contact.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachTagsModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/contacts/{id}/tags/list/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/custom-field-definitions/": { "get": { "tags": [ "CustomFieldDefinitions" ], "summary": "Get all custom field definitions from a organization.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } } }, "text/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } } }, "text/plain": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/custom-field-definitions/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "CustomFieldDefinitions" ], "summary": "Allows adding a custom field definition to an existing organization that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateTextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateNumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateLinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateLogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateMemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateDateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateDecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateListStringCustomFieldDefinitionModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateTextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateNumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateLinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateLogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateMemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateDateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateDecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateListStringCustomFieldDefinitionModel" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateTextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateNumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateLinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateLogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateMemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateDateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateCurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateDecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CreateListStringCustomFieldDefinitionModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/custom-field-definitions/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/custom-field-definitions/{id}/": { "get": { "tags": [ "CustomFieldDefinitions" ], "summary": "Get a custom field definition from a organization by Id.\nThe Id of the custom field definition to get", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/custom-field-definitions/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "CustomFieldDefinitions" ], "summary": "Allows editing a custom field definition to an existing organization that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The id of the custom field definition to edit", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditCustomFieldDefinitionModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditCustomFieldDefinitionModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditCustomFieldDefinitionModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CurrencyCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/TextCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LogicCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/NumberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/LinkCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/MemberCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CNPJCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/CPFCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DateCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/DecimalCustomFieldDefinitionModel" }, { "$ref": "#/components/schemas/ListStringCustomFieldDefinitionModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/custom-field-definitions/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "CustomFieldDefinitions" ], "summary": "Deletes a custom field definition to a organization by its Id", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the organization custom field definition to delete", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/custom-field-definitions/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/": { "get": { "tags": [ "KnowledgeBases" ], "summary": "Gets all knowledge bases for the organization.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/knowledge-bases/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "KnowledgeBases" ], "summary": "Creates a new knowledge base.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateKnowledgeBaseRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateKnowledgeBaseRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateKnowledgeBaseRequestModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/knowledge-bases/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/name/": { "put": { "tags": [ "KnowledgeBases" ], "summary": "Updates the name of a knowledge base.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateKnowledgeBaseNameRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateKnowledgeBaseNameRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateKnowledgeBaseNameRequestModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/knowledge-bases/{kbId}/name/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/agents/": { "get": { "tags": [ "KnowledgeBases" ], "summary": "Gets the agents that use a specific knowledge base.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseAgentModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseAgentModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseAgentModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/knowledge-bases/{kbId}/agents/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/ingest/": { "post": { "tags": [ "KnowledgeBases" ], "summary": "Triggers ingestion for a knowledge base.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IngestStatus" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IngestStatus" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/knowledge-bases/{kbId}/ingest/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/import-qas-from-chats/": { "post": { "tags": [ "KnowledgeBases" ], "summary": "Triggers Q&A generation from closed chats for a knowledge base.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/knowledge-bases/{kbId}/import-qas-from-chats/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/qa/file/": { "post": { "tags": [ "KnowledgeBases" ], "summary": "Creates Q&As for a knowledge base from a file.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "The file containing the Q&As. Currently supports CSV, XLS, and XLSX", "format": "binary" } } }, "encoding": { "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentQAModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentQAModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentQAModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/knowledge-bases/{kbId}/qa/file/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/qa/": { "get": { "tags": [ "KnowledgeBases" ], "summary": "Gets Q&As for a knowledge base.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "query", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentQAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentQAModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentQAModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/knowledge-bases/{kbId}/qa/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&query=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "KnowledgeBases" ], "summary": "Creates a Q&A for a knowledge base.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentQAModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentQAModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentQAModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/knowledge-bases/{kbId}/qa/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/qa/{qaId}/": { "delete": { "tags": [ "KnowledgeBases" ], "summary": "Deletes a Q&A from a knowledge base.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "qaId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AIAgentQAModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/knowledge-bases/{kbId}/qa/{qaId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/website-crawlers/": { "get": { "tags": [ "KnowledgeBases" ], "summary": "Gets website crawlers for a knowledge base.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "query", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfWebsiteCrawlerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfWebsiteCrawlerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfWebsiteCrawlerModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/knowledge-bases/{kbId}/website-crawlers/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&query=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "KnowledgeBases" ], "summary": "Creates a website crawler for a knowledge base.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentWebsiteCrawlerModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentWebsiteCrawlerModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAIAgentWebsiteCrawlerModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/knowledge-bases/{kbId}/website-crawlers/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/website-crawlers/{crawlerId}/": { "delete": { "tags": [ "KnowledgeBases" ], "summary": "Deletes a website crawler from a knowledge base.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "crawlerId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/WebsiteCrawlerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/knowledge-bases/{kbId}/website-crawlers/{crawlerId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/documents/": { "get": { "tags": [ "KnowledgeBases" ], "summary": "Gets documents for a knowledge base.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "query", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentDocumentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentDocumentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfAIAgentDocumentModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/knowledge-bases/{kbId}/documents/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&query=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "KnowledgeBases" ], "summary": "Adds a document to a knowledge base.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Document" ], "type": "object", "properties": { "Document": { "type": "string", "format": "binary" } } }, "encoding": { "Document": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDocumentModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDocumentModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDocumentModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/knowledge-bases/{kbId}/documents/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/knowledge-bases/{kbId}/documents/{documentId}/": { "delete": { "tags": [ "KnowledgeBases" ], "summary": "Deletes a document from a knowledge base.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "kbId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentDocumentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AIAgentDocumentModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AIAgentDocumentModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/knowledge-bases/{kbId}/documents/{documentId}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/members/me/": { "get": { "tags": [ "Members" ], "summary": "This action returns all the information about you, the logged in user. It also includes the list of organizations you're a part of.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/members/me/\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Members" ], "summary": "Updates information about yourself that are not specific to an organization.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationMemberModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationMemberModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationMemberModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/members/me/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/members/me/profilepicture/": { "put": { "tags": [ "Members" ], "summary": "Allows to update your own profile picture", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "type": "object", "properties": { "image": { "type": "string", "description": "The new photo", "format": "binary" } } }, "encoding": { "image": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "uri", "example": "https://example.com" } }, "text/json": { "schema": { "type": "string", "format": "uri", "example": "https://example.com" } }, "text/plain": { "schema": { "type": "string", "format": "uri", "example": "https://example.com" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/members/me/profilepicture/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/members/online/": { "get": { "tags": [ "Members" ], "summary": "Lists all members that are online. A member is considered online when they have at least one app instance running with the specified organization selected", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationAIAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationHumanAgentReferenceModel" } ] } } }, "text/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationAIAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationHumanAgentReferenceModel" } ] } } }, "text/plain": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationAIAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationHumanAgentReferenceModel" } ] } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/members/online/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/members/{id}/activation-status/": { "put": { "tags": [ "Members" ], "summary": "Allows to update the activation status (active, disabled) of a user in an organization.\nIf you're an Admin in the selected organization, you can enable or disable any user in that organization.\nIf your permission is below Admin, you're only allowed to disable yourself.\nWhen deactivating someone, it is possible to choose whether or not to close all conversations with this attendant.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the user to update the activation status", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationMemberStatusModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationMemberStatusModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationMemberStatusModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMemberActivationStatusModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationMemberActivationStatusModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationMemberActivationStatusModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/members/{id}/activation-status/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/members/organizations/": { "get": { "tags": [ "Members" ], "summary": "Returns the basic data of the member identified by the given email,\nalong with the list of organizations they belong to.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "email", "in": "query", "description": "The member's email address used to find their organizations.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "$ref": "#/components/schemas/AIOrganizationAgentModel" }, { "$ref": "#/components/schemas/HumanOrganizationAgentModel" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/members/organizations/?email=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/{id}/": { "get": { "tags": [ "Messages" ], "summary": "Gets all the information about a single message", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the message", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/messages/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Messages" ], "summary": "Attempts to delete a message. Depending on the type of channel and the desired \"deleteForEveryone\" behavior, these things might happen:\n1. The message needs to be deleted only in out database and is deleted immediately within this action. (Business channel, delete for me).\n2. The message cannot be deleted because the remote locations where the message should also be deleted no longer accept to be deleted because of time restraints (Starter channel, delete for everyone).\n3. The remote location where the message should also be deleted does not allow messages to deleted at all (Business channel, delete for everyone).\n4. The message can be deleted in the remote location, but the only thing the action does is request it. Deletion from our database only happens when we receive a confirmation that the message was actually deleted (Starter channel, delete for me or everyone).", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The message to delete", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "deleteForEveryone", "in": "query", "description": "Attempts to delete for everyone in the chat if true. Attempts to delete just for ourselves when false.", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/messages/{id}/?organizationId='AB_12-xyzEXAMPLE'&deleteForEveryone=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Messages" ], "summary": "Edits a message that was previously sent.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the message to edit", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "The new content for the message", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditMessageModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditMessageModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditMessageModel" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/messages/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/{id}/states/": { "get": { "tags": [ "Messages" ], "summary": "Gets a list of all the states a message had at every point in time", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the message", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageStatesModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MessageStatesModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/MessageStatesModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/messages/{id}/states/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/": { "post": { "tags": [ "Messages" ], "summary": "Post a message to a chat", "description": "Rate limit: Up to 250 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMessageModel" } }, "multipart/form-data": { "schema": { "required": [ "ChatId", "OrganizationId" ], "type": "object", "properties": { "TempId": { "type": "string", "description": "An Id generated by the client that is passed along when the message is comitted to the database and has the true id. Not necessary for fire-and-forget situations" }, "File": { "type": "string", "format": "binary" }, "Prefix": { "type": "string", "description": "A prefix to be concatenated with the message. Used by the app to include the operator name. Not required" }, "Message": { "maxLength": 2000, "type": "string", "description": "The message to send", "default": "Mensagem de teste" }, "ChatId": { "type": "string", "description": "The Id of the chat to send the message to. Must exist and be open", "example": "AB_12-xyzEXAMPLE" }, "IsPrivate": { "type": "boolean", "description": "Private messages are not sent to the contact, they function like an internal annotation", "default": false }, "PreviousMessageId": { "type": "string", "description": "Used by the app to ensure messages are sent in order. Not necessary", "example": "AB_12-xyzEXAMPLE" }, "StickUrl": { "type": "string", "description": "If the message you're sendind is a sticker, here you put its URL", "format": "uri", "example": "https://example.com" }, "ReplyToMessageId": { "type": "string", "description": "When the message you're sending is a reply to another message, use the other message's Id here", "example": "AB_12-xyzEXAMPLE" }, "OrganizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "SkipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false }, "Automated": { "type": "boolean", "description": "When true, indicates that the message was sent by an automated system. Currently, disables the behavior where sending a message stops bots from running.\nThis settings is experimental and may change in the future.", "default": false }, "FileId": { "type": "string", "description": "The file id that has already been saved in the organization files.", "example": "AB_12-xyzEXAMPLE" }, "Contacts": { "type": "string" }, "Elements": { "type": "string" }, "Mentions": { "type": "string" } } }, "encoding": { "TempId": { "style": "form" }, "File": { "style": "form" }, "Prefix": { "style": "form" }, "Message": { "style": "form" }, "ChatId": { "style": "form" }, "IsPrivate": { "style": "form" }, "PreviousMessageId": { "style": "form" }, "StickUrl": { "style": "form" }, "ReplyToMessageId": { "style": "form" }, "OrganizationId": { "style": "form" }, "SkipReassign": { "style": "form" }, "Automated": { "style": "form" }, "FileId": { "style": "form" }, "Contacts": { "style": "form" }, "Elements": { "style": "form" }, "Mentions": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/messages/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/reactions/": { "post": { "tags": [ "Messages" ], "summary": "POST Messages", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReactionModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReactionModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReactionModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReactionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReactionModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ReactionModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/messages/reactions/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/{id}/forward/": { "post": { "tags": [ "Messages" ], "summary": "Forwards a message into another chat", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the message to be forwarded", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForwardMessageModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForwardMessageModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForwardMessageModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/messages/{id}/forward/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/simplified/": { "post": { "tags": [ "Messages" ], "summary": "Simplified version of the regular POST action. Does not require to create the contact and open the chat beforehand. But it is not only simplified, it's also somewhat more limited. If you require a functionality this action does not provide, the main action must be used instead.", "description": "Rate limit: Up to 250 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageSimplifiedModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMessageSimplifiedModel" } }, "multipart/form-data": { "schema": { "required": [ "FromPhone", "OrganizationId", "ToPhone" ], "type": "object", "properties": { "ToPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "FromPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "OrganizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "Message": { "maxLength": 2000, "type": "string", "default": "Mensagem de teste" }, "File": { "type": "string", "format": "binary" }, "SkipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false }, "ContactName": { "type": "string", "description": "An optional name to create the contact with if it does not exist. Will be ignored if the contact already exists" } } }, "encoding": { "ToPhone": { "style": "form" }, "FromPhone": { "style": "form" }, "OrganizationId": { "style": "form" }, "Message": { "style": "form" }, "File": { "style": "form" }, "SkipReassign": { "style": "form" }, "ContactName": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/messages/simplified/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/{id}/resend/": { "put": { "tags": [ "Messages" ], "summary": "PUT Messages", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/messages/{id}/resend/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/{id}/redownload-media/": { "put": { "tags": [ "Messages" ], "summary": "PUT Messages", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/messages/{id}/redownload-media/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/{id}/mark-favorite-message/": { "put": { "tags": [ "Messages" ], "summary": "Set message as favorite.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "chat id", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "messageId", "in": "query", "description": "The message to edit", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/messages/{id}/mark-favorite-message/?organizationId='AB_12-xyzEXAMPLE'&messageId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/{id}/unmark-favorite-message/": { "put": { "tags": [ "Messages" ], "summary": "Set message as NOT favorite.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "chat id", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "messageId", "in": "query", "description": "The message to edit", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/messages/{id}/unmark-favorite-message/?organizationId='AB_12-xyzEXAMPLE'&messageId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/messages/{id}/clear-favorite-messages/": { "put": { "tags": [ "Messages" ], "summary": "Limpar a lista de mensagens favoritas.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "chat id", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "The message to edit", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/messages/{id}/clear-favorite-messages/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bot-shortcuts/": { "post": { "tags": [ "OrganizationBotShortcut" ], "summary": "Adds a new bot shortcut for the specified organization.\nRequires Admin permission and the \"BotShortcutsEnabled\" feature to be enabled.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBotShortcutModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBotShortcutModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBotShortcutModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/bot-shortcuts/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bot-shortcuts/{id}/": { "put": { "tags": [ "OrganizationBotShortcut" ], "summary": "Updates an existing bot shortcut with the specified identifier.\nRequires Admin permission and the \"BotShortcutsEnabled\" feature to be enabled.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotShortcutModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotShortcutModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotShortcutModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/bot-shortcuts/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "OrganizationBotShortcut" ], "summary": "Deletes an existing bot shortcut with the specified identifier.\nRequires Admin permission and the \"BotShortcutsEnabled\" feature to be enabled.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/bot-shortcuts/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/bot-shortcuts/{id}/reorder/": { "put": { "tags": [ "OrganizationBotShortcut" ], "summary": "Reorders an existing bot shortcut with the specified identifier.\nRequires Admin permission and the \"BotShortcutsEnabled\" feature to be enabled.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotShortcutOrderModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotShortcutOrderModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBotShortcutOrderModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BotShortcutModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/bot-shortcuts/{id}/reorder/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organization-files/": { "get": { "tags": [ "OrganizationFiles" ], "summary": "Gets a paginated list of all the OrganizationFiles saved previously", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "SearchText", "in": "query", "schema": { "type": "string" } }, { "name": "FileTypes.Rule", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] } }, { "name": "FileTypes.Values", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypes" } } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfOrganizationFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfOrganizationFileModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfOrganizationFileModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/organization-files/?organizationId='AB_12-xyzEXAMPLE'&SearchText=''&FileTypes.Rule=''&FileTypes.Values=''&Order=''&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "OrganizationFiles" ], "summary": "POST Organization-Files", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "OrganizationId" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Thumbnail": { "type": "string" }, "OrganizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "encoding": { "File": { "style": "form" }, "Thumbnail": { "style": "form" }, "OrganizationId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/organization-files/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organization-files/{id}/": { "get": { "tags": [ "OrganizationFiles" ], "summary": "Gets a OrganizationFile saved previously", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/organization-files/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "OrganizationFiles" ], "summary": "DELETE Organization-Files", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/organization-files/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organization-files/{id}/visibility/": { "put": { "tags": [ "OrganizationFiles" ], "summary": "PUT Organization-Files", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "visibility", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/FileVisibility" } ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationFileModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/organization-files/{id}/visibility/?organizationId='AB_12-xyzEXAMPLE'&visibility=''\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/groups/": { "post": { "tags": [ "OrganizationGroup" ], "summary": "Adds a new group to the specified organization.\nRequires at least Admin permission and the \"GroupsEnabled\" feature to be enabled.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateGroupModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateGroupModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateGroupModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/GroupModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/groups/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/groups/{id}/": { "put": { "tags": [ "OrganizationGroup" ], "summary": "Updates an existing group within the organization.\nRequires at least Admin permission and the \"GroupsEnabled\" feature to be enabled.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateGroupModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateGroupModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateGroupModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/GroupModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/groups/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "OrganizationGroup" ], "summary": "Deletes an existing group from the organization.\nRequires at least Admin permission and the \"GroupsEnabled\" feature to be enabled.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/groups/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/groups/{id}/reorder/": { "put": { "tags": [ "OrganizationGroup" ], "summary": "Updates the order of a group within the organization, adjusting its position based on the specified order.\nRequires at least Admin permission and the \"GroupsEnabled\" feature to be enabled.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateGroupOrderModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateGroupOrderModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateGroupOrderModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/GroupModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/groups/{id}/reorder/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organization-invites/": { "get": { "tags": [ "OrganizationInvites" ], "summary": "Gets a list of invitations that were sent by the selected organization", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationInviteModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationInviteModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationInviteModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/organization-invites/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "OrganizationInvites" ], "summary": "Creates a new invitation and sends it to the destined e-mail address", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SendOrganizationInviteModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SendOrganizationInviteModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SendOrganizationInviteModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/organization-invites/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organization-invites/{email}/": { "get": { "tags": [ "OrganizationInvites" ], "summary": "Gets additional information about a single pending invitation of the supplied e-mail address", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "email", "in": "path", "description": "The e-mail to search an invite with", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/organization-invites/{email}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "OrganizationInvites" ], "summary": "Cancels an invitation", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "email", "in": "path", "description": "The invited e-mail address to cancel", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/organization-invites/{email}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organization-invites/{email}/resend/": { "put": { "tags": [ "OrganizationInvites" ], "summary": "Resets the invitation. Generates a new link and sends it again to the destined email address.", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "email", "in": "path", "description": "The invitation to resend", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationInviteModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/organization-invites/{email}/resend/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organizations/{organizationId}/preferences/": { "put": { "tags": [ "OrganizationPreferences" ], "summary": "Allows to update organization-level preferences", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationPreferencesModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationPreferencesModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationPreferencesModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationPreferencesDetailsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationPreferencesDetailsModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationPreferencesDetailsModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/organizations/{organizationId}/preferences/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organizations/{id}/": { "get": { "tags": [ "Organizations" ], "summary": "Gets information about an organization you're a part of that are essential for other actions", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the organization", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleOrganizationModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleOrganizationModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleOrganizationModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/organizations/{id}/\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Organizations" ], "summary": "Updates information about an organization", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the organization", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateOrganizationModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/organizations/{id}/\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Organizations" ], "summary": "Deletes an organization", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the organization", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "reason", "in": "query", "description": "Reason for deleting the channel", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleOrganizationModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleOrganizationModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SimpleOrganizationModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/organizations/{id}/?reason=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organizations/{id}/member/{memberId}/": { "put": { "tags": [ "Organizations" ], "summary": "Updates information of a member that is specific to an organization", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMemberDetailsInOrganizationModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMemberDetailsInOrganizationModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMemberDetailsInOrganizationModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationAIAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationHumanAgentReferenceModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationAIAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationHumanAgentReferenceModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationAIAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationHumanAgentReferenceModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/organizations/{id}/member/{memberId}/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organizations/{id}/details/": { "get": { "tags": [ "Organizations" ], "summary": "Gets profile information about an organization you're a part of", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the organization", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/organizations/{id}/details/\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organizations/{id}/credits/": { "get": { "tags": [ "Organizations" ], "summary": "Gets information about the organization current conversation windows limits", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the organization", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreditModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/organizations/{id}/credits/\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/organizations/{id}/picture/": { "put": { "tags": [ "Organizations" ], "summary": "Update the picture of an organization", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the organization", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "type": "object", "properties": { "image": { "type": "string", "description": "The new profile picture", "format": "binary" } } }, "encoding": { "image": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/organizations/{id}/picture/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/permissions/": { "put": { "tags": [ "Permissions" ], "summary": "Update permissions of an existing member", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdatePermissionOrganizationMemberModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdatePermissionOrganizationMemberModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdatePermissionOrganizationMemberModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionOrganizationMemberModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PermissionOrganizationMemberModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PermissionOrganizationMemberModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/permissions/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/permissions/organization-member/": { "get": { "tags": [ "Permissions" ], "summary": "Gets the current permissions of an existing member", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "memberId", "in": "query", "description": "The Id of the member", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPermissionsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPermissionsModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UserPermissionsModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/permissions/organization-member/?organizationId='AB_12-xyzEXAMPLE'&memberId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/quick-answers/": { "get": { "tags": [ "QuickAnswers" ], "summary": "Gets a paginated list of all quick answers in the organization. With some filtering options", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "queryString", "in": "query", "schema": { "type": "string" } }, { "name": "viewFrom", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ViewQuickAnswersFrom" } ] } }, { "name": "OrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/QuickAnswersProperty" } ] } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "groupIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleQuickAnswerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleQuickAnswerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleQuickAnswerModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/quick-answers/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&queryString=''&viewFrom=''&OrderBy=''&Order=''&groupIds=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "QuickAnswers" ], "summary": "Create a new quick answer for yourself or the organization", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateQuickAnswerModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateQuickAnswerModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateQuickAnswerModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/quick-answers/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/quick-answers/{id}/": { "get": { "tags": [ "QuickAnswers" ], "summary": "Gets additional information about a single quick answer", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The quick answer Id", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/quick-answers/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "QuickAnswers" ], "summary": "Updates an existing quick answer", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the quick answer", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateQuickAnswerModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateQuickAnswerModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateQuickAnswerModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/quick-answers/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "QuickAnswers" ], "summary": "Deletes an existing quick answer", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the quick answer", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/quick-answers/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/quick-answers/{id}/groups/": { "post": { "tags": [ "QuickAnswers" ], "summary": "Adds one or more group IDs to the quick answer", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the quick answer", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/QuickAnswerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/quick-answers/{id}/groups/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/scheduled-messages/{id}/": { "get": { "tags": [ "ScheduledMessages" ], "summary": "Gets additional information about a single scheduled message", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The scheduled message Id", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/scheduled-messages/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "ScheduledMessages" ], "summary": "Updates the details of an existing scheduled message", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The scheduled message to update", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateScheduledMessageModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateScheduledMessageModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateScheduledMessageModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/scheduled-messages/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "ScheduledMessages" ], "summary": "Cancels an existing scheduled message", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The id of the scheduled message to cancel", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } }, "text/plain": { "schema": { "type": "boolean" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/scheduled-messages/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/scheduled-messages/": { "get": { "tags": [ "ScheduledMessages" ], "summary": "Gets a paginated list of scheduled messages meant to a single contact", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "contactId", "in": "query", "description": "The contact to retrieve the scheduled messages from", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfScheduledMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfScheduledMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfScheduledMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/scheduled-messages/?organizationId='AB_12-xyzEXAMPLE'&contactId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "ScheduledMessages" ], "summary": "Creates a new scheduled message", "description": "Rate limit: Up to 250 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateScheduledMessageModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateScheduledMessageModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateScheduledMessageModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ScheduledMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/scheduled-messages/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/sectors/": { "get": { "tags": [ "Sectors" ], "summary": "Gets all the sectors of the selected organization", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SectorReferenceModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SectorReferenceModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SectorReferenceModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/sectors/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Sectors" ], "summary": "Creates a new sector in the organization", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSectorModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSectorModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSectorModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SectorModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/sectors/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/sectors/{id}/": { "get": { "tags": [ "Sectors" ], "summary": "Gets more details of a single sector", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the sector", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SectorModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/sectors/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Sectors" ], "summary": "Updates the details of an existing sector", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the sector", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSectorModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSectorModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSectorModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SectorModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/sectors/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Sectors" ], "summary": "Delete an existing sector, moving its chats to another sector first", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the sector", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "moveChatsToSector", "in": "query", "description": "The sector the chats in the current sector must be move to", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SectorModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/sectors/{id}/?organizationId='AB_12-xyzEXAMPLE'&moveChatsToSector='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/sectors/reorder/": { "put": { "tags": [ "Sectors" ], "summary": "PUT Sectors", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SectorModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/sectors/reorder/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/sectors/{id}/order/": { "put": { "tags": [ "Sectors" ], "summary": "Updates the ordering of a sector", "description": "Rate limit: Up to 10 requests in a 15 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the sector", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSectorOrderModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSectorOrderModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSectorOrderModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SectorModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "deprecated": true, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/sectors/{id}/order/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/sectors/{id}/groups/": { "post": { "tags": [ "Sectors" ], "summary": "Adds one or more group IDs to the sector", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the sector", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SectorModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SectorModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/sectors/{id}/groups/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/stickers/": { "get": { "tags": [ "Stickers" ], "summary": "Gets a paginated list of all the stickers the organization saved previously", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfStickerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfStickerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfStickerModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/stickers/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Stickers" ], "summary": "Add a sticker to the organization's sticker repository", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateStickerModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateStickerModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateStickerModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StickerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StickerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StickerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/stickers/\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Stickers" ], "summary": "Remove a sticker from the organization's sticker repository", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "url", "in": "query", "description": "The sticker url to remove", "required": true, "schema": { "type": "string", "format": "uri", "example": "https://example.com" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StickerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StickerModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StickerModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/stickers/?organizationId='AB_12-xyzEXAMPLE'&url='https://example.com'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/stickers/existing/": { "get": { "tags": [ "Stickers" ], "summary": "Attempts to find a previously saved sticker by its image's URL", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "stickUrl", "in": "query", "required": true, "schema": { "type": "string", "format": "uri", "example": "https://example.com" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StickerModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StickerModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StickerModel" } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/stickers/existing/?organizationId='AB_12-xyzEXAMPLE'&stickUrl='https://example.com'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/tags/{id}/": { "get": { "tags": [ "Tags" ], "summary": "Gets additional information about a tag by its Id", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the tag", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TagModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/tags/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Tags" ], "summary": "Updates an existing tag", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the tag", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTagModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTagModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTagModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TagModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/tags/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Tags" ], "summary": "Deletes a tag from the organization", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the tag", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TagModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/tags/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/tags/": { "get": { "tags": [ "Tags" ], "summary": "Gets a paginated list of tags created in the organization", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "OrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/TagProperty" } ] } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "queryString", "in": "query", "schema": { "type": "string" } }, { "name": "groupIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfTagModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfTagModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfTagModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/tags/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''&OrderBy=''&Order=''&queryString=''&groupIds=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Tags" ], "summary": "Creates a new tag in the organization", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTagModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTagModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTagModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TagModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/tags/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/tags/reorder/": { "put": { "tags": [ "Tags" ], "summary": "PUT Tags", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReorderModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TagModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/tags/reorder/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/tags/{id}/groups/": { "post": { "tags": [ "Tags" ], "summary": "Adds one or more group IDs to the tag", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the channel to edit", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TagModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/tags/{id}/groups/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/template-categories/": { "get": { "tags": [ "TemplateCategories" ], "summary": "Lists all categories a template can be created with. Note that some are marked as deprecated, those are shown for compatibility reasons only. They're not allowed to be used anymore.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateCategoryModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateCategoryModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateCategoryModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/template-categories/\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/template-messages/": { "post": { "tags": [ "TemplateMessages" ], "summary": "Sends a template message to an existing chat", "description": "Rate limit: Up to 250 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateMessageModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTemplateMessageModel" } }, "multipart/form-data": { "schema": { "required": [ "ChatId", "OrganizationId", "TemplateId" ], "type": "object", "properties": { "TemplateId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "ChatId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "Params": { "maxLength": 1024, "minLength": 1, "type": "array", "items": { "type": "string" } }, "OrganizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "SkipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false }, "BulkSession": { "type": "string", "description": "Used to group messages by a bulk send session", "example": "AB_12-xyzEXAMPLE" }, "File": { "type": "string", "description": "Prefer to use FileId instead", "format": "binary" }, "FileId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "Carousel": { "type": "string" }, "PostbackTexts": { "type": "string", "description": "JSON string representing the list of postback texts associated with quick reply buttons." } } }, "encoding": { "TemplateId": { "style": "form" }, "ChatId": { "style": "form" }, "Params": { "style": "form" }, "OrganizationId": { "style": "form" }, "SkipReassign": { "style": "form" }, "BulkSession": { "style": "form" }, "File": { "style": "form" }, "FileId": { "style": "form" }, "Carousel": { "style": "form" }, "PostbackTexts": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/template-messages/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/template-messages/simplified/": { "post": { "tags": [ "TemplateMessages" ], "summary": "POST Template-Messages", "description": "Rate limit: Up to 250 requests in a 5 seconds window", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateMessageSimplifiedModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTemplateMessageSimplifiedModel" } }, "multipart/form-data": { "schema": { "required": [ "FromPhone", "OrganizationId", "TemplateId", "ToPhone" ], "type": "object", "properties": { "ToPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "FromPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "TemplateId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "Params": { "maxLength": 1024, "minLength": 1, "type": "array", "items": { "type": "string" } }, "OrganizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "SkipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false }, "BulkSession": { "type": "string", "description": "Used to group messages by a bulk send session", "example": "AB_12-xyzEXAMPLE" }, "File": { "type": "string", "description": "Prefer to use FileId instead", "format": "binary" }, "FileId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "ContactName": { "type": "string", "description": "An optional name to create the contact with if it does not exist. Will be ignored if the contact already exists" }, "Carousel": { "type": "string" } } }, "encoding": { "ToPhone": { "style": "form" }, "FromPhone": { "style": "form" }, "TemplateId": { "style": "form" }, "Params": { "style": "form" }, "OrganizationId": { "style": "form" }, "SkipReassign": { "style": "form" }, "BulkSession": { "style": "form" }, "File": { "style": "form" }, "FileId": { "style": "form" }, "ContactName": { "style": "form" }, "Carousel": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SentMessageModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/template-messages/simplified/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/templates/": { "get": { "tags": [ "Templates" ], "summary": "Gets a paginated list of all the message templates from an organization. Optionally filtering by a single channel within the organization and/or their statuses.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "channelId", "in": "query", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } }, { "name": "queryString", "in": "query", "schema": { "type": "string" } }, { "name": "OrderBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/TemplateProperty" } ] } }, { "name": "Order", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] } }, { "name": "groupIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleTemplateModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfSimpleTemplateModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/templates/?organizationId='AB_12-xyzEXAMPLE'&channelId='AB_12-xyzEXAMPLE'&status=''&Skip=''&Take=''&Behavior=''&queryString=''&OrderBy=''&Order=''&groupIds=''\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Templates" ], "summary": "Creates and submits a new template for Meta's approval", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTemplateModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTemplateModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTemplateModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/templates/\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "put": { "tags": [ "Templates" ], "summary": "Updates template. You can only update information that is not dependent on Gupshup.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTemplateModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTemplateModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTemplateModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/templates/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/templates/{id}/": { "get": { "tags": [ "Templates" ], "summary": "Gets additional information about a template by its Id", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the template", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/templates/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Templates" ], "summary": "Deletes an existing template. Note that it's also deleted in your meta account", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the template", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/templates/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/templates/{id}/groups/": { "post": { "tags": [ "Templates" ], "summary": "Adds one or more group IDs to the template", "description": "Rate limit: Up to 50 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the template", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachGroupModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TemplateModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/templates/{id}/groups/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/user-notifications/": { "get": { "tags": [ "UserNotifications" ], "summary": "Returns a paginated list of unread notifications for the current user,\nexcluding those related to marketing campaigns and user mentions.", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfUserNotificationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfUserNotificationModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfUserNotificationModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/user-notifications/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/user-notifications/mention/": { "get": { "tags": [ "UserNotifications" ], "summary": "Returns a paginated list of unread notifications for the current user,\nincluding only notifications related to user mentions.", "description": "Rate limit: Up to 100 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "Skip", "in": "query", "description": "How many items to skip before start taking ones to return", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Take", "in": "query", "description": "The amount of items to get after the specified offset. Can be more than there are items available, but not more than this route's limit of items per page.", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Behavior", "in": "query", "description": "How the query should execute", "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginationBehavior" } ], "default": "GetSliceOnly" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginationOfUserNotificationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginationOfUserNotificationModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/PaginationOfUserNotificationModel" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/user-notifications/mention/?organizationId='AB_12-xyzEXAMPLE'&Skip=''&Take=''&Behavior=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/user-notifications/{id}/": { "put": { "tags": [ "UserNotifications" ], "summary": "Marks a notification as read", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the notification", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserNotificationModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UserNotificationModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/user-notifications/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/user-notifications/all/": { "put": { "tags": [ "UserNotifications" ], "summary": "Marks all unread notifications as read, excluding mention notifications.", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/user-notifications/all/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/user-notifications/all-mentions/": { "put": { "tags": [ "UserNotifications" ], "summary": "Marks all unread mention notifications as read for the current user.", "description": "Rate limit: Up to 50 requests in a 5 seconds windowWarning! This endpoint is not marked as stable.
\nIt's either incomplete or intended to be used only by the Umbler Talk frontend.
\nYou can still use it if you want, but be aware that it's not supported and may break at any time without notice.
", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationModel" } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "red", "label": "Unstable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/user-notifications/all-mentions/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/variables/": { "get": { "tags": [ "Variables" ], "summary": "Get all variables from a organization.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } } }, "text/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } } }, "text/plain": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/variables/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "post": { "tags": [ "Variables" ], "summary": "Allows adding a variable to an existing organization that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateVariableModel" }, { "$ref": "#/components/schemas/CreatePlainTextVariableModel" }, { "$ref": "#/components/schemas/CreateEncryptedVariableModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateVariableModel" }, { "$ref": "#/components/schemas/CreatePlainTextVariableModel" }, { "$ref": "#/components/schemas/CreateEncryptedVariableModel" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateVariableModel" }, { "$ref": "#/components/schemas/CreatePlainTextVariableModel" }, { "$ref": "#/components/schemas/CreateEncryptedVariableModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PostAsync(\"/v1/variables/\", content);\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/variables/{id}/": { "put": { "tags": [ "Variables" ], "summary": "Allows editing a variable to an existing organization that can be retrieved later in the full GET method.", "description": "Rate limit: Up to 10 requests in a 15 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The id of the variable to edit", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditVariableModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditVariableModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditVariableModel" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } }, "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "$ref": "#/components/schemas/PlainTextVariableModel" }, { "$ref": "#/components/schemas/EncryptedVariableModel" } ] } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar body = \nvar content = new StringContent(body, System.Text.Encoding.UTF8, \"application/json\");\nvar res = await client.PutAsync(\"/v1/variables/{id}/?organizationId='AB_12-xyzEXAMPLE'\", content);\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Variables" ], "summary": "Deletes a variable to a organization by its Id", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the organization variable to delete", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/variables/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/webhooks/": { "get": { "tags": [ "Webhooks" ], "summary": "Gets a list of webhooks registered in the desired organization", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "channelId", "in": "query", "description": "Optionally you can pass a channel Id to retrieve only webhooks registered in it", "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "query", "in": "query", "description": "Optionally, you can pass a query string to filter webhooks' names", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookModel" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookModel" } } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/webhooks/?organizationId='AB_12-xyzEXAMPLE'&channelId='AB_12-xyzEXAMPLE'&query=''\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/webhooks/{id}/": { "get": { "tags": [ "Webhooks" ], "summary": "Gets all available information of a single webhook", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The Id of the registered webhook", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/webhooks/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] }, "delete": { "tags": [ "Webhooks" ], "summary": "Deletes a webhook registration. After successfully deleted, it may take a few seconds for the desired URL start to stop receiving events.", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, { "name": "id", "in": "path", "description": "The id of the webhook registration to disable and delete", "required": true, "schema": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookModel" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookModel" } } } }, "404": { "description": "An object with the sent identifier could not be found", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "$ref": "#/components/schemas/HttpValidationProblemDetails" } ] } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "security": [ { "Bearer": [ ] } ], "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.DeleteAsync(\"/v1/webhooks/{id}/?organizationId='AB_12-xyzEXAMPLE'\");\nres.EnsureSuccessStatusCode();\n" } ] } }, "/v1/webhooks/ranges/": { "get": { "tags": [ "Webhooks" ], "summary": "Lists all IP ranges we can send Webhooks from", "description": "Rate limit: Up to 100 requests in a 5 seconds window", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceRanges" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SourceRanges" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/SourceRanges" } } } }, "500": { "description": "When an unexpected internal server error occurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorBasicDetails" } } } }, "400": { "description": "Will return a BadRequest if a property has an invalid value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } }, "x-badges": [ { "color": "green", "label": "Stable" } ], "x-codeSamples": [ { "lang": "CSharp", "label": "C#", "source": "var client = new HttpClient { BaseAddress = new Uri(\"https://app-utalk.umbler.com\"),};\nclient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Bearer\", \"API_TOKEN\");\nvar res = await client.GetAsync(\"/v1/webhooks/ranges/\");\nres.EnsureSuccessStatusCode();\n" } ] } } }, "components": { "schemas": { "AIAgentDocumentModel": { "title": "AIAgentDocumentModel", "required": [ "fileName", "id" ], "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "fileName": { "type": "string" }, "content": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AIAgentQAModel": { "title": "AIAgentQAModel", "required": [ "content", "id", "title" ], "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "title": { "type": "string" }, "content": { "type": "string" }, "source": { "allOf": [ { "$ref": "#/components/schemas/AIAgentQASource" } ] } }, "additionalProperties": false }, "AIAgentQASource": { "title": "AIAgentQASource", "enum": [ "Manual", "AIGenerated" ], "type": "string" }, "AIAgentWorkloadModel": { "title": "AIAgentWorkloadModel", "required": [ "sourceType" ], "type": "object", "properties": { "sourceType": { "type": "string" }, "total": { "type": "number", "format": "float" }, "processed": { "type": "number", "format": "float" } }, "additionalProperties": false }, "AICapturedVariable": { "title": "AICapturedVariable", "type": "object", "properties": { "key": { "type": "string" }, "description": { "type": "string" }, "regexValidator": { "type": "string" }, "isRequired": { "type": "boolean" }, "dataType": { "type": "string" } }, "additionalProperties": false }, "AILLMDetailsModel": { "title": "AILLMDetailsModel", "type": "object", "properties": { "llm": { "allOf": [ { "$ref": "#/components/schemas/AiLLMs" } ], "readOnly": true }, "creditsPerMessage": { "type": "integer", "format": "int32", "readOnly": true }, "visible": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AILocale": { "title": "AILocale", "enum": [ "EN_US", "FR_FR", "PT_PT", "PT_BR", "ES_ES", "ES_MX", "ES_PE", "ES_AR", "ES_CL", "ES_CO" ], "type": "string" }, "AIOrganizationAgentModel": { "title": "AIOrganizationAgentModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "required": [ "voice" ], "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/AIStatuses" } ], "readOnly": true }, "chatbotType": { "allOf": [ { "$ref": "#/components/schemas/BotTypes" } ] }, "botLLM": { "allOf": [ { "$ref": "#/components/schemas/AiLLMs" } ] }, "voice": { "allOf": [ { "$ref": "#/components/schemas/AgentVoiceModel" } ] } }, "additionalProperties": false } ] }, "AIStatuses": { "title": "AIStatuses", "enum": [ "Draft", "Testing", "Staging", "Published", "Suspended", "Updated", "Deprecated", "Deleted" ], "type": "string" }, "ActivityLogModel": { "title": "ActivityLogModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "type": "object", "properties": { "organizationId": { "type": "string", "nullable": true, "readOnly": true, "example": "AB_12-xyzEXAMPLE" }, "url": { "type": "string", "nullable": true, "readOnly": true }, "controller": { "type": "string", "nullable": true, "readOnly": true }, "method": { "type": "string", "nullable": true, "readOnly": true }, "details": { "type": "string", "nullable": true, "readOnly": true }, "referenceId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "uTalkUserId": { "type": "string", "nullable": true, "readOnly": true, "example": "AB_12-xyzEXAMPLE" }, "activityLogType": { "allOf": [ { "$ref": "#/components/schemas/ActivityLogType" } ], "readOnly": true }, "authSource": { "allOf": [ { "$ref": "#/components/schemas/AuthSource" } ], "readOnly": true } }, "additionalProperties": false } ] }, "ActivityLogSimpleModel": { "title": "ActivityLogSimpleModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "type": "object", "properties": { "organizationId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "referenceId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "uTalkUserId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "activityLogType": { "allOf": [ { "$ref": "#/components/schemas/ActivityLogType" } ] }, "details": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ActivityLogType": { "title": "ActivityLogType", "enum": [ "Generic", "ChatTransfered", "ContactCreated", "ContactUpdated", "ContactDeleted", "ChatCreated", "ChatClosed", "ChatSectorUpdate", "ChatPrivated", "ChatPublic", "PermissionUpdated", "MessageTemplateCreated", "MessageTemplateUpdated", "MessageTemplateDeleted", "TagCreated", "TagUpdated", "TagDeleted", "BotCreated", "BotUpdated", "BotDeleted", "InviteCreated", "InviteUpdated", "InviteDeleted", "WebhookCreated", "WebhookUpdated", "WebhookDeleted", "SectorCreated", "SectorUpdated", "SectorDeleted", "QuickAnswerCreated", "QuickAnswerUpdated", "QuickAnswerDeleted", "ScheduledMessageCreated", "ScheduledMessageDeleted", "ScheduledMessageUpdated", "ScheduledMessageSent", "ContractPendence", "BotPaused", "BotResumed", "ScheduledMessageError", "ChannelCreated", "PaymentReceived", "MarketingNotification", "CreditPackageBought", "CreditPackageBoughtDiscount", "CreditWarning", "AccountWarning", "OrganizationUpdated", "ChannelRestart", "ChannelMigrateStarterV2", "Mention", "ContactNoteMention", "IpBlocklistAdded", "IpBlocklistRemoved" ], "type": "string" }, "AdModel": { "title": "AdModel", "type": "object", "properties": { "conversionSource": { "type": "string", "nullable": true }, "sourceUrl": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "thumbnailUrl": { "type": "string", "nullable": true }, "mediaUrl": { "type": "string", "nullable": true }, "sourceType": { "type": "string", "nullable": true }, "sourceId": { "type": "string", "description": "Official - It is the Facebook ID for an Ad or a post", "nullable": true }, "fileId": { "type": "string", "description": "Official - The Ad's image or video ID.", "nullable": true }, "ctWaCLId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddressModel": { "title": "AddressModel", "type": "object", "properties": { "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdmAIUsageMessageModel": { "title": "AdmAIUsageMessageModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "chat" ], "type": "object", "properties": { "eventAtUTC": { "type": "string", "format": "date-time" }, "content": { "type": "string", "nullable": true }, "messageState": { "allOf": [ { "$ref": "#/components/schemas/MessageStates" } ] }, "messageType": { "allOf": [ { "$ref": "#/components/schemas/MessageTypes" } ], "description": "All the possibilities of a message" }, "isPrivate": { "type": "boolean" }, "source": { "allOf": [ { "$ref": "#/components/schemas/MessageSources" } ] }, "chat": { "allOf": [ { "$ref": "#/components/schemas/ChatIdReferenceModel" } ] }, "sentByOrganizationMember": { "allOf": [ { "$ref": "#/components/schemas/AgentReferenceIdModel" } ], "nullable": true } }, "additionalProperties": false } ] }, "AdmMessageModel": { "title": "AdmMessageModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "type": "object", "properties": { "eventAtUTC": { "type": "string", "format": "date-time" }, "content": { "type": "string", "nullable": true }, "messageState": { "allOf": [ { "$ref": "#/components/schemas/MessageStates" } ] }, "messageType": { "allOf": [ { "$ref": "#/components/schemas/MessageTypes" } ], "description": "All the possibilities of a message" }, "reason": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "isPrivate": { "type": "boolean" }, "source": { "allOf": [ { "$ref": "#/components/schemas/MessageSources" } ] }, "sentByOrganizationMember": { "allOf": [ { "$ref": "#/components/schemas/AgentReferenceIdModel" } ], "nullable": true } }, "additionalProperties": false } ] }, "AgentFunctionTemplateModel": { "title": "AgentFunctionTemplateModel", "required": [ "botLLM", "chatbotType", "description", "idealFor", "isPopular", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "idealFor": { "type": "string" }, "isPopular": { "type": "boolean" }, "chatbotType": { "allOf": [ { "$ref": "#/components/schemas/BotTypes" } ] }, "botLLM": { "allOf": [ { "$ref": "#/components/schemas/AiLLMs" } ] }, "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AgentIdentityOption": { "title": "AgentIdentityOption", "enum": [ "Human", "AIAssistant" ], "type": "string" }, "AgentPreTrainedSectorModel": { "title": "AgentPreTrainedSectorModel", "required": [ "functions", "sector" ], "type": "object", "properties": { "sector": { "type": "string" }, "functions": { "type": "array", "items": { "$ref": "#/components/schemas/AgentFunctionTemplateModel" } } }, "additionalProperties": false }, "AgentReferenceIdModel": { "title": "AgentReferenceIdModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "AgentReferenceModel": { "title": "AgentReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "_t", "displayName" ], "type": "object", "properties": { "_t": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "AgentReferenceModel": "#/components/schemas/AgentReferenceModel", "CloserAgentReferenceModel": "#/components/schemas/CloserAgentReferenceModel", "QuickAnswerAgentReferenceModel": "#/components/schemas/QuickAnswerAgentReferenceModel" } } } ] }, "AgentVoiceModel": { "title": "AgentVoiceModel", "required": [ "id", "name", "sample" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sample": { "type": "string", "format": "uri", "example": "https://example.com" }, "creditsPerResponse": { "type": "integer", "format": "int32" }, "default": { "type": "boolean" }, "language": { "type": "string", "nullable": true }, "accent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AggregationType": { "title": "AggregationType", "enum": [ "None", "Count", "Sum", "Average", "Min", "Max" ], "type": "string" }, "AiIntentModel": { "title": "AiIntentModel", "required": [ "action", "description" ], "type": "object", "properties": { "description": { "minLength": 1, "type": "string" }, "action": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ] }, "required": { "type": "boolean" }, "replyAfterExecuteTool": { "type": "boolean" }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "AiLLMs": { "title": "AiLLMs", "enum": [ "Expert", "Standard", "Custom" ], "type": "string" }, "AiMcpToolModel": { "title": "AiMcpToolModel", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "description": { "type": "string", "nullable": true }, "required": { "type": "boolean" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "AiMcpToolModel": "#/components/schemas/AiMcpToolModel", "GoogleCalendarMcpToolModel": "#/components/schemas/GoogleCalendarMcpToolModel", "ExternalApiMcpToolModel": "#/components/schemas/ExternalApiMcpToolModel", "GoogleSheetsMcpToolModel": "#/components/schemas/GoogleSheetsMcpToolModel" } } }, "AiStageModel": { "title": "AiStageModel", "required": [ "actionDescription", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "actionDescription": { "type": "string" }, "botAddedDateUTC": { "type": "string", "format": "date-time", "nullable": true }, "triggerBot": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ], "nullable": true } }, "additionalProperties": false }, "AllowedNodeTypes": { "title": "AllowedNodeTypes", "enum": [ "All", "BasicOnly", "Essentials" ], "type": "string", "description": "This enum is used in Umbler.UTalk.Core.Util.UTalkFeatures.\nPlease see its documentation before making any changes." }, "ApiEndpointModel": { "title": "ApiEndpointModel", "type": "object", "properties": { "endpointId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "name": { "type": "string" }, "canExecuteQueries": { "type": "boolean" }, "url": { "type": "string" }, "method": { "allOf": [ { "$ref": "#/components/schemas/WebhookMethod" } ] }, "details": { "type": "string", "nullable": true }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/ApiHeaderModel" }, "nullable": true }, "body": { "type": "string" }, "aiVariables": { "type": "array", "items": { "$ref": "#/components/schemas/AICapturedVariable" } } }, "additionalProperties": false }, "ApiHeaderModel": { "title": "ApiHeaderModel", "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "AsaasActionModel": { "title": "AsaasActionModel", "allOf": [ { "$ref": "#/components/schemas/WebhookActionModel" }, { "type": "object", "additionalProperties": false } ] }, "AttachGroupModel": { "title": "AttachGroupModel", "required": [ "groupIds" ], "type": "object", "properties": { "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "AttachTagModel": { "title": "AttachTagModel", "required": [ "organizationId", "tagId" ], "type": "object", "properties": { "tagId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "AttachTagsModel": { "title": "AttachTagsModel", "required": [ "organizationId", "tagIds" ], "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "AuthSource": { "title": "AuthSource", "enum": [ "Unknown", "OIDC", "PAT", "Other", "Unauthenticated" ], "type": "string" }, "AvailableCalendarModel": { "title": "AvailableCalendarModel", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "BasicBulkSendSessionModel": { "title": "BasicBulkSendSessionModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "channel", "initiatedBy", "messagesSent", "title" ], "type": "object", "properties": { "_t": { "type": "string" }, "title": { "type": "string" }, "initiatedBy": { "allOf": [ { "$ref": "#/components/schemas/UTalkUserIdReferenceModel" } ] }, "messagesSent": { "type": "integer", "format": "int32" }, "totalScheduled": { "type": "integer", "format": "int32", "nullable": true }, "channel": { "allOf": [ { "$ref": "#/components/schemas/ChannelReferenceIdModel" } ] } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "BasicBulkSendSessionModel": "#/components/schemas/BasicBulkSendSessionModel", "BulkSendSessionModel": "#/components/schemas/BulkSendSessionModel" } } } ] }, "BasicChatModel": { "title": "BasicChatModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "bots", "channel", "contact", "organization", "organizationMemberHistory", "organizationMembers", "sector", "sectorHistory", "tags" ], "type": "object", "properties": { "_t": { "type": "string" }, "organization": { "allOf": [ { "$ref": "#/components/schemas/OrganizationReferenceIdModel" } ], "description": "Short contact reference" }, "contact": { "allOf": [ { "$ref": "#/components/schemas/ContactReferenceModel" } ], "description": "Short contact reference" }, "channel": { "oneOf": [ { "$ref": "#/components/schemas/ChatChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/ChatInternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/ChatWelcomerChannelReferenceModel" }, { "$ref": "#/components/schemas/ChatMembersChannelReferenceModel" }, { "$ref": "#/components/schemas/ChatExternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/ChatWebsiteWidgetChannelReferenceModel" }, { "$ref": "#/components/schemas/ChatPhoneNumberChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/ChatBrokerWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/ChatGupshupWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/ChatCloudAPIWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/ChatUsernameChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/ChatInstagramChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/ChatGupshupInstagramChannelReferenceModel" } ], "description": "Short channel reference" }, "sector": { "allOf": [ { "$ref": "#/components/schemas/SectorReferenceModel" } ], "description": "Short Sector reference" }, "sectorHistory": { "type": "array", "items": { "$ref": "#/components/schemas/SectorHistoryReferenceModel" }, "description": "History of previous sectors associated in chat." }, "organizationMember": { "allOf": [ { "$ref": "#/components/schemas/ChatAgentReferenceModel" } ], "description": "The current member that has the chat", "nullable": true }, "organizationMembers": { "type": "array", "items": { "$ref": "#/components/schemas/ChatAgentReferenceModel" }, "description": "All the members who participated in this chat" }, "organizationMemberHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMemberReferenceModel" }, "description": "History of organization members associated with this instance." }, "tags": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SimpleTagReferenceModel" }, { "$ref": "#/components/schemas/TagModel" } ] } }, "lastMessage": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ], "description": "Last message sent or received. Shortcut for displaying", "nullable": true }, "lastMessageReaction": { "allOf": [ { "$ref": "#/components/schemas/MessageReactionModel" } ], "nullable": true }, "redactReason": { "allOf": [ { "$ref": "#/components/schemas/RedactReason" } ], "nullable": true }, "usingInactivityFlow": { "type": "boolean", "nullable": true }, "usingWaitingFlow": { "type": "boolean", "nullable": true }, "inactivityFlowAt": { "type": "string", "format": "date-time", "nullable": true }, "waitingFlowAt": { "type": "string", "format": "date-time", "nullable": true }, "open": { "type": "boolean" }, "private": { "type": "boolean" }, "waiting": { "type": "boolean" }, "waitingSinceUTC": { "type": "string", "format": "date-time", "nullable": true }, "totalUnread": { "type": "integer", "format": "int32" }, "totalAIResponses": { "type": "integer", "format": "int32", "nullable": true }, "closedAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "closedBy": { "allOf": [ { "$ref": "#/components/schemas/SimpleAgentReferenceModel" } ], "nullable": true, "readOnly": true }, "eventAtUTC": { "type": "string", "format": "date-time" }, "firstMemberReplyMessage": { "allOf": [ { "$ref": "#/components/schemas/MessageReferenceModel" } ], "nullable": true }, "firstContactMessage": { "allOf": [ { "$ref": "#/components/schemas/MessageReferenceModel" } ], "nullable": true }, "bots": { "type": "array", "items": { "$ref": "#/components/schemas/BotInstanceChatDataModel" } }, "lastOrganizationMember": { "allOf": [ { "$ref": "#/components/schemas/AgentReferenceIdModel" } ], "nullable": true }, "message": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ], "nullable": true }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/ChatVisibility" } ], "description": "Indicates the visibility of the chat is set to Show or Hide.", "nullable": true }, "favoriteMessages": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "BasicChatModel": "#/components/schemas/BasicChatModel", "ChatModel": "#/components/schemas/ChatModel" } } } ], "description": "Model containing only the basic info to display a chat" }, "BasicWidgetProfileModel": { "title": "BasicWidgetProfileModel", "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "picture": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" } }, "additionalProperties": false }, "BatchSimplifiedCustomFieldItemModel": { "title": "BatchSimplifiedCustomFieldItemModel", "required": [ "name", "value" ], "type": "object", "properties": { "name": { "maxLength": 160, "minLength": 0, "type": "string" }, "value": { "maxLength": 2000, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "BatchSimplifiedCustomFieldModel": { "title": "BatchSimplifiedCustomFieldModel", "required": [ "customFields" ], "type": "object", "properties": { "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/BatchSimplifiedCustomFieldItemModel" } }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "BillingEventType": { "title": "BillingEventType", "enum": [ "Template", "AI" ], "type": "string" }, "BlockSignatureBehaviorModel": { "title": "BlockSignatureBehaviorModel", "type": "object", "properties": { "behavior": { "allOf": [ { "$ref": "#/components/schemas/BlockSignatureBehaviors" } ] } }, "additionalProperties": false }, "BlockSignatureBehaviors": { "title": "BlockSignatureBehaviors", "enum": [ "AlwaysShowSignature", "MemberDecides", "NeverShowSignature" ], "type": "string" }, "BotBaseModel": { "title": "BotBaseModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "channels", "title" ], "type": "object", "properties": { "_t": { "type": "string" }, "lastSnapshotId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelReferenceIdModel" }, "description": "A list of all the channels this bot will act upon" }, "title": { "type": "string", "description": "The title of this bot, for internal reference only" }, "order": { "type": "number", "description": "The order this bot should be put alongside others when executing", "format": "float" }, "final": { "type": "boolean", "description": "When true, will prevent the execution of further bots on the channel if this bot decides it should execute" }, "active": { "type": "boolean" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "description": "The list of group IDs for this bot." }, "updatedAtUTC": { "type": "string", "description": "The exact time the entity was updated in UTC", "format": "date-time", "nullable": true }, "executionsCount": { "type": "integer", "description": "How many times the entity was executed", "format": "int32", "nullable": true }, "executionsDateUTC": { "type": "string", "description": "The exact date the entity was executed in UTC", "format": "date-time", "nullable": true }, "snapshotTitle": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "BotBaseModel": "#/components/schemas/BotBaseModel", "TaggingBotModel": "#/components/schemas/TaggingBotModel", "SectorForwardingBotModel": "#/components/schemas/SectorForwardingBotModel", "GreetingBotModel": "#/components/schemas/GreetingBotModel", "FlowchartBotModel": "#/components/schemas/FlowchartBotModel" } } } ] }, "BotBaseWrapperModel": { "title": "BotBaseWrapperModel", "type": "object", "properties": { "bot": { "oneOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "$ref": "#/components/schemas/TaggingBotModel" }, { "$ref": "#/components/schemas/SectorForwardingBotModel" }, { "$ref": "#/components/schemas/GreetingBotModel" }, { "$ref": "#/components/schemas/FlowchartBotModel" } ] } }, "additionalProperties": false }, "BotBindingEntry": { "title": "BotBindingEntry", "required": [ "name", "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/BotBindingType" } ] }, "name": { "type": "string" }, "referenceId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "BotBindingType": { "title": "BotBindingType", "enum": [ "FlowchartReference", "CloseChatBehavior", "WaitingFlowBehavior", "ReassignBehavior", "InactivityFlowBehavior", "Channel", "BotShortcut", "WidgetButton", "AIAgentIntent" ], "type": "string" }, "BotBindingsModel": { "title": "BotBindingsModel", "type": "object", "properties": { "bindings": { "type": "array", "items": { "$ref": "#/components/schemas/BotBindingEntry" } }, "hasBindings": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BotEvent": { "title": "BotEvent", "enum": [ "ChatCreatedByContact", "ContactMessage", "ChatCreated", "MemberMessage", "Manual", "Waiting" ], "type": "string" }, "BotInstanceChatDataModel": { "title": "BotInstanceChatDataModel", "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/BotStatus" } ] }, "botId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "botTitle": { "type": "string", "nullable": true }, "botInstanceId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "botSnapshotId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "triggerName": { "type": "string", "nullable": true }, "stopReason": { "allOf": [ { "$ref": "#/components/schemas/BotStopReason" } ], "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BotInstanceReferenceModel": { "title": "BotInstanceReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "_t", "botName" ], "type": "object", "properties": { "_t": { "type": "string" }, "botName": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "BotInstanceReferenceModel": "#/components/schemas/BotInstanceReferenceModel", "ScheduledMessageBotReferenceModel": "#/components/schemas/ScheduledMessageBotReferenceModel" } } } ] }, "BotInstanceStepReferenceModel": { "title": "BotInstanceStepReferenceModel", "type": "object", "properties": { "botId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "botInstanceId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "stepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "BotOptionModel": { "title": "BotOptionModel", "required": [ "stepId", "text" ], "type": "object", "properties": { "text": { "type": "string" }, "stepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "BotProperty": { "title": "BotProperty", "enum": [ "Order", "Title", "CreatedAtUTC", "Active", "UpdatedAtUTC", "ExecutionsCount" ], "type": "string" }, "BotQuestionModel": { "title": "BotQuestionModel", "required": [ "_t", "key" ], "type": "object", "properties": { "_t": { "type": "string" }, "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "key": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "BotQuestionModel": "#/components/schemas/BotQuestionModel", "ObjectiveBotQuestionModel": "#/components/schemas/ObjectiveBotQuestionModel", "SubjectiveQuestionModel": "#/components/schemas/SubjectiveQuestionModel" } } }, "BotShortcutModel": { "title": "BotShortcutModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "actionTitle", "allowEditOnBotSend", "bot", "icon", "order" ], "type": "object", "properties": { "icon": { "type": "string" }, "actionTitle": { "type": "string" }, "bot": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ] }, "order": { "type": "integer", "format": "int32" }, "allowEditOnBotSend": { "type": "boolean" } }, "additionalProperties": false } ] }, "BotSnapshotModel": { "title": "BotSnapshotModel", "required": [ "bot", "id" ], "type": "object", "properties": { "bot": { "oneOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "$ref": "#/components/schemas/TaggingBotModel" }, { "$ref": "#/components/schemas/SectorForwardingBotModel" }, { "$ref": "#/components/schemas/GreetingBotModel" }, { "$ref": "#/components/schemas/FlowchartBotModel" } ] }, "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "botId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "botTitle": { "type": "string" }, "executionsCount": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "updatedBy": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BotStatus": { "title": "BotStatus", "enum": [ "Waiting", "Running", "Complete" ], "type": "string" }, "BotStopReason": { "title": "BotStopReason", "enum": [ "ReachedFlowEnd", "MemberTookOver", "ChatClosed", "OtherBotTookOver", "BotFeatureDisabled", "ContractPendency", "InconsistencyFound", "ManuallyRequested", "BotExpired", "FatalError", "BotNotFound", "LoopInterrupted" ], "type": "string" }, "BotTrigger": { "title": "BotTrigger", "enum": [ "ChatCreated", "Manual" ], "type": "string" }, "BotTypes": { "title": "BotTypes", "enum": [ "Support", "Sales", "Qualification", "SupportV2" ], "type": "string" }, "BrokerWhatsappChannelModel": { "title": "BrokerWhatsappChannelModel", "allOf": [ { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "type": "object", "properties": { "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelFilter" } ], "readOnly": true, "deprecated": true }, "lastSyncDate": { "type": "string", "format": "date-time" }, "autoSync": { "type": "boolean" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "BulkSendBotInstanceReferenceModel": { "title": "BulkSendBotInstanceReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "botName", "triggerName" ], "type": "object", "properties": { "botName": { "type": "string" }, "triggerName": { "type": "string" } }, "additionalProperties": false } ] }, "BulkSendMessageModel": { "title": "BulkSendMessageModel", "type": "object", "properties": { "chatId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "messageId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "state": { "allOf": [ { "$ref": "#/components/schemas/MessageStates" } ] }, "eventAtUTC": { "type": "string", "format": "date-time" }, "contactId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "contactName": { "type": "string", "nullable": true }, "contactProfilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "isResend": { "type": "boolean" } }, "additionalProperties": false }, "BulkSendProperty": { "title": "BulkSendProperty", "enum": [ "Title", "InitiatedBy", "CreatedAtUTC", "MessagesSent" ], "type": "string" }, "BulkSendScheduleModel": { "title": "BulkSendScheduleModel", "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "dateSendAtUTC": { "type": "string", "format": "date-time" }, "chatId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "messageId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ScheduledMessageStatus" } ] }, "eventAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "contactId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "contactName": { "type": "string", "nullable": true }, "contactPhoneNumber": { "type": "string", "nullable": true }, "contactProfilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "isResend": { "type": "boolean" }, "cancelReason": { "allOf": [ { "$ref": "#/components/schemas/ScheduledMessageCanceledReason" } ], "nullable": true }, "messageStatus": { "allOf": [ { "$ref": "#/components/schemas/MessageStates" } ], "nullable": true }, "botStatus": { "allOf": [ { "$ref": "#/components/schemas/BotStatus" } ], "nullable": true }, "botStopReason": { "allOf": [ { "$ref": "#/components/schemas/BotStopReason" } ], "nullable": true } }, "additionalProperties": false }, "BulkSendSessionModel": { "title": "BulkSendSessionModel", "allOf": [ { "$ref": "#/components/schemas/BasicBulkSendSessionModel" }, { "type": "object", "properties": { "bot": { "allOf": [ { "$ref": "#/components/schemas/BulkSendBotInstanceReferenceModel" } ], "nullable": true }, "template": { "allOf": [ { "$ref": "#/components/schemas/SimpleTemplateModel" } ], "nullable": true }, "totalFailed": { "type": "integer", "format": "int32", "deprecated": true }, "totalRead": { "type": "integer", "format": "int32", "deprecated": true }, "totalProcessing": { "type": "integer", "format": "int32", "deprecated": true }, "totalSent": { "type": "integer", "format": "int32", "deprecated": true }, "messageStates": { "type": "array", "items": { "$ref": "#/components/schemas/StateCountOfMessageStates" } }, "scheduleStates": { "type": "array", "items": { "$ref": "#/components/schemas/StateCountOfScheduledMessageStatus" } }, "botStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/StateCountOfBotStatus" } }, "botStopReasons": { "type": "array", "items": { "$ref": "#/components/schemas/StateCountOfBotStopReason" } } }, "additionalProperties": false } ] }, "BulkSendSessionReferenceModel": { "title": "BulkSendSessionReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "BusinessHourConditionalModel": { "title": "BusinessHourConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "isOpen": { "type": "boolean", "nullable": true } }, "additionalProperties": false } ] }, "BusinessHourReferenceModel": { "title": "BusinessHourReferenceModel", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "name": { "type": "string" } }, "additionalProperties": false }, "BusinessType": { "title": "BusinessType", "enum": [ "AUTO", "BEAUTY", "EDU", "ENTERTAIN", "FINANCE", "GOVT", "HOTEL", "GROCERY", "NONPROFIT", "EVENT_PLAN", "RESTAURANT", "HEALTH", "PROF_SERVICES", "RETAIL", "APPAREL", "TRAVEL", "OTHER" ], "type": "string" }, "CNPJCustomFieldDefinitionModel": { "title": "CNPJCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CPFCustomFieldDefinitionModel": { "title": "CPFCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CalendarModel": { "title": "CalendarModel", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "canCheckAvailability": { "type": "boolean" }, "availabilityText": { "type": "string" }, "canCreateEvent": { "type": "boolean" }, "canRescheduleEvent": { "type": "boolean" }, "defineEventTypes": { "type": "boolean" }, "eventTypes": { "type": "array", "items": { "$ref": "#/components/schemas/EventType" } } }, "additionalProperties": false }, "CallBehaviorModel": { "title": "CallBehaviorModel", "type": "object", "properties": { "behavior": { "allOf": [ { "$ref": "#/components/schemas/CallBehaviors" } ] }, "bot": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ], "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CallBehaviors": { "title": "CallBehaviors", "enum": [ "Ignore", "ExecuteBot", "SendMessage" ], "type": "string" }, "CancelScheduledMessageUpon": { "title": "CancelScheduledMessageUpon", "enum": [ "CustomerMessage", "OrganizationMemberMessage", "ClosedChat" ], "type": "string" }, "CapabilityChannelEvent": { "title": "CapabilityChannelEvent", "allOf": [ { "$ref": "#/components/schemas/ChannelEvent" }, { "type": "object", "properties": { "maxDailyConversationPerPhone": { "type": "integer", "format": "int32" }, "maxPhoneNumbersPerBusiness": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "ChangeChatPrivateStateActionModel": { "title": "ChangeChatPrivateStateActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartActionModel" }, { "type": "object", "properties": { "private": { "type": "boolean" } }, "additionalProperties": false } ] }, "ChannelBaseModel": { "title": "ChannelBaseModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "displayName", "organization" ], "type": "object", "properties": { "_t": { "type": "string" }, "displayName": { "type": "string" }, "pictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "defaultSector": { "allOf": [ { "$ref": "#/components/schemas/SectorReferenceModel" } ], "nullable": true }, "defaultBusinessHour": { "allOf": [ { "$ref": "#/components/schemas/BusinessHourReferenceModel" } ], "nullable": true }, "state": { "allOf": [ { "$ref": "#/components/schemas/ChannelState" } ] }, "organization": { "allOf": [ { "$ref": "#/components/schemas/OrganizationReferenceIdModel" } ] }, "deleteReason": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChannelBaseModel": "#/components/schemas/ChannelBaseModel", "InternalChannelBaseModel": "#/components/schemas/InternalChannelBaseModel", "WelcomerChannelModel": "#/components/schemas/WelcomerChannelModel", "MembersChannelModel": "#/components/schemas/MembersChannelModel", "ExternalChannelBaseModel": "#/components/schemas/ExternalChannelBaseModel", "PhoneNumberChannelBaseModel": "#/components/schemas/PhoneNumberChannelBaseModel", "WhatsappChannelBaseModel": "#/components/schemas/WhatsappChannelBaseModel", "BrokerWhatsappChannelModel": "#/components/schemas/BrokerWhatsappChannelModel", "GupshupWhatsappChannelModel": "#/components/schemas/GupshupWhatsappChannelModel", "CloudAPIWhatsappChannelModel": "#/components/schemas/CloudAPIWhatsappChannelModel", "UsernameChannelBaseModel": "#/components/schemas/UsernameChannelBaseModel", "InstagramChannelBaseModel": "#/components/schemas/InstagramChannelBaseModel", "GupshupInstagramChannelModel": "#/components/schemas/GupshupInstagramChannelModel", "WebsiteWidgetChannelModel": "#/components/schemas/WebsiteWidgetChannelModel" } } } ] }, "ChannelConditionalModel": { "title": "ChannelConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "conditionalType": { "allOf": [ { "$ref": "#/components/schemas/ChannelConditionalType" } ], "nullable": true } }, "additionalProperties": false } ] }, "ChannelConditionalType": { "title": "ChannelConditionalType", "enum": [ "ChannelId", "BusinessHour" ], "type": "string" }, "ChannelEvent": { "title": "ChannelEvent", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "eventAtUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChannelEvent": "#/components/schemas/ChannelEvent", "ReviewChannelEvent": "#/components/schemas/ReviewChannelEvent", "StatusChannelEvent": "#/components/schemas/StatusChannelEvent", "PNDNChannelEvent": "#/components/schemas/PNDNChannelEvent", "TierChannelEvent": "#/components/schemas/TierChannelEvent", "CapabilityChannelEvent": "#/components/schemas/CapabilityChannelEvent" } } }, "ChannelFilter": { "title": "ChannelFilter", "enum": [ "WhatsappApi", "WhatsappBroker", "Welcomer", "Instagram", "Members", "WebsiteWidget", "WhatsappCloudApi" ], "type": "string" }, "ChannelMetricsModel": { "title": "ChannelMetricsModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "displayName", "organization" ], "type": "object", "properties": { "displayName": { "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/ChannelState" } ] }, "organization": { "allOf": [ { "$ref": "#/components/schemas/OrganizationReferenceIdModel" } ] }, "dateSentFirstMessageUTC": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false } ] }, "ChannelReferenceIdModel": { "title": "ChannelReferenceIdModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ChannelState": { "title": "ChannelState", "enum": [ "WaitingAppCreation", "WaitingToGoLive", "Probation", "Live", "Offline", "Deleted", "WaitingFirstSync", "Disabled" ], "type": "string" }, "ChatAgentReferenceModel": { "title": "ChatAgentReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "properties": { "muted": { "type": "boolean", "nullable": true }, "totalUnread": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } ] }, "ChatBrokerWhatsappChannelReferenceModel": { "title": "ChatBrokerWhatsappChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel" }, { "type": "object", "properties": { "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelFilter" } ], "readOnly": true, "deprecated": true } }, "additionalProperties": false } ] }, "ChatChannelReferenceBaseModel": { "title": "ChatChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChatChannelReferenceBaseModel": "#/components/schemas/ChatChannelReferenceBaseModel", "ChatInternalChannelReferenceBaseModel": "#/components/schemas/ChatInternalChannelReferenceBaseModel", "ChatWelcomerChannelReferenceModel": "#/components/schemas/ChatWelcomerChannelReferenceModel", "ChatMembersChannelReferenceModel": "#/components/schemas/ChatMembersChannelReferenceModel", "ChatExternalChannelReferenceBaseModel": "#/components/schemas/ChatExternalChannelReferenceBaseModel", "ChatWebsiteWidgetChannelReferenceModel": "#/components/schemas/ChatWebsiteWidgetChannelReferenceModel", "ChatPhoneNumberChannelReferenceBaseModel": "#/components/schemas/ChatPhoneNumberChannelReferenceBaseModel", "ChatWhatsappChannelReferenceBaseModel": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel", "ChatBrokerWhatsappChannelReferenceModel": "#/components/schemas/ChatBrokerWhatsappChannelReferenceModel", "ChatGupshupWhatsappChannelReferenceModel": "#/components/schemas/ChatGupshupWhatsappChannelReferenceModel", "ChatCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/ChatCloudAPIWhatsappChannelReferenceModel", "ChatUsernameChannelReferenceBaseModel": "#/components/schemas/ChatUsernameChannelReferenceBaseModel", "ChatInstagramChannelReferenceBaseModel": "#/components/schemas/ChatInstagramChannelReferenceBaseModel", "ChatGupshupInstagramChannelReferenceModel": "#/components/schemas/ChatGupshupInstagramChannelReferenceModel" } } } ] }, "ChatCloudAPIWhatsappChannelReferenceModel": { "title": "ChatCloudAPIWhatsappChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ChatContactModel": { "title": "ChatContactModel", "required": [ "addresses", "emails", "phoneNumbers" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressModel" } }, "phoneNumbers": { "type": "array", "items": { "type": "string" } }, "company": { "type": "string", "nullable": true }, "emails": { "type": "array", "items": { "type": "string" } }, "profilePictureBlob": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatExternalChannelReferenceBaseModel": { "title": "ChatExternalChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/ChatChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChatExternalChannelReferenceBaseModel": "#/components/schemas/ChatExternalChannelReferenceBaseModel", "ChatWebsiteWidgetChannelReferenceModel": "#/components/schemas/ChatWebsiteWidgetChannelReferenceModel", "ChatPhoneNumberChannelReferenceBaseModel": "#/components/schemas/ChatPhoneNumberChannelReferenceBaseModel", "ChatWhatsappChannelReferenceBaseModel": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel", "ChatBrokerWhatsappChannelReferenceModel": "#/components/schemas/ChatBrokerWhatsappChannelReferenceModel", "ChatGupshupWhatsappChannelReferenceModel": "#/components/schemas/ChatGupshupWhatsappChannelReferenceModel", "ChatCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/ChatCloudAPIWhatsappChannelReferenceModel", "ChatUsernameChannelReferenceBaseModel": "#/components/schemas/ChatUsernameChannelReferenceBaseModel", "ChatInstagramChannelReferenceBaseModel": "#/components/schemas/ChatInstagramChannelReferenceBaseModel", "ChatGupshupInstagramChannelReferenceModel": "#/components/schemas/ChatGupshupInstagramChannelReferenceModel" } } } ] }, "ChatFilterModel": { "title": "ChatFilterModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceBaseModel" }, { "type": "object", "properties": { "sectors": { "allOf": [ { "$ref": "#/components/schemas/FieldFilterOfObjectId" } ] }, "tags": { "allOf": [ { "$ref": "#/components/schemas/FieldFilterOfObjectId" } ] }, "members": { "allOf": [ { "$ref": "#/components/schemas/FieldFilterOfObjectId" } ] }, "channels": { "allOf": [ { "$ref": "#/components/schemas/FieldFilterOfObjectId" } ] }, "chatState": { "allOf": [ { "$ref": "#/components/schemas/ChatState" } ] }, "lastMessage": { "allOf": [ { "$ref": "#/components/schemas/LastMessage" } ] }, "order": { "allOf": [ { "$ref": "#/components/schemas/Order" } ] }, "dateStartCreatedAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "dateEndCreatedAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "position": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } ] }, "ChatGupshupInstagramChannelReferenceModel": { "title": "ChatGupshupInstagramChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ChatInstagramChannelReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ChatGupshupWhatsappChannelReferenceModel": { "title": "ChatGupshupWhatsappChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel" }, { "type": "object", "properties": { "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelFilter" } ], "readOnly": true, "deprecated": true } }, "additionalProperties": false } ] }, "ChatIdReferenceModel": { "title": "ChatIdReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ChatInstagramChannelReferenceBaseModel": { "title": "ChatInstagramChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/ChatUsernameChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChatInstagramChannelReferenceBaseModel": "#/components/schemas/ChatInstagramChannelReferenceBaseModel", "ChatGupshupInstagramChannelReferenceModel": "#/components/schemas/ChatGupshupInstagramChannelReferenceModel" } } } ] }, "ChatInternalChannelReferenceBaseModel": { "title": "ChatInternalChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/ChatChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChatInternalChannelReferenceBaseModel": "#/components/schemas/ChatInternalChannelReferenceBaseModel", "ChatWelcomerChannelReferenceModel": "#/components/schemas/ChatWelcomerChannelReferenceModel", "ChatMembersChannelReferenceModel": "#/components/schemas/ChatMembersChannelReferenceModel" } } } ] }, "ChatMemberReferenceModel": { "title": "ChatMemberReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "properties": { "memberId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "muted": { "type": "boolean", "nullable": true }, "totalUnread": { "type": "integer", "format": "int32", "nullable": true }, "enteredAt": { "type": "string", "format": "date-time" }, "firstMemberReplyMessage": { "allOf": [ { "$ref": "#/components/schemas/MessageReferenceModel" } ], "nullable": true }, "firstContactMessage": { "allOf": [ { "$ref": "#/components/schemas/MessageReferenceModel" } ], "nullable": true }, "transferredBy": { "allOf": [ { "$ref": "#/components/schemas/ChatTransferInfoModel" } ], "nullable": true } }, "additionalProperties": false } ] }, "ChatMembersChannelReferenceModel": { "title": "ChatMembersChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ChatInternalChannelReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ChatModel": { "title": "ChatModel", "allOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "type": "object", "properties": { "hasMessagesBeforeAllowedHistory": { "type": "boolean" }, "latestMessages": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } }, "additionalProperties": false } ] }, "ChatOrderBy": { "title": "ChatOrderBy", "enum": [ "CreatedAtUTC", "LastMessage", "WaitingSince" ], "type": "string" }, "ChatPhoneNumberChannelReferenceBaseModel": { "title": "ChatPhoneNumberChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/ChatExternalChannelReferenceBaseModel" }, { "required": [ "_t", "phoneNumber" ], "type": "object", "properties": { "_t": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChatPhoneNumberChannelReferenceBaseModel": "#/components/schemas/ChatPhoneNumberChannelReferenceBaseModel", "ChatWhatsappChannelReferenceBaseModel": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel", "ChatBrokerWhatsappChannelReferenceModel": "#/components/schemas/ChatBrokerWhatsappChannelReferenceModel", "ChatGupshupWhatsappChannelReferenceModel": "#/components/schemas/ChatGupshupWhatsappChannelReferenceModel", "ChatCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/ChatCloudAPIWhatsappChannelReferenceModel" } } } ] }, "ChatState": { "title": "ChatState", "enum": [ "Open", "Closed", "All" ], "type": "string" }, "ChatTransferInfoModel": { "title": "ChatTransferInfoModel", "type": "object", "properties": { "sourceId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "reason": { "allOf": [ { "$ref": "#/components/schemas/TransferReason" } ], "nullable": true }, "sourceType": { "allOf": [ { "$ref": "#/components/schemas/TransferSourceType" } ], "nullable": true } }, "additionalProperties": false }, "ChatUsernameChannelReferenceBaseModel": { "title": "ChatUsernameChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/ChatExternalChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChatUsernameChannelReferenceBaseModel": "#/components/schemas/ChatUsernameChannelReferenceBaseModel", "ChatInstagramChannelReferenceBaseModel": "#/components/schemas/ChatInstagramChannelReferenceBaseModel", "ChatGupshupInstagramChannelReferenceModel": "#/components/schemas/ChatGupshupInstagramChannelReferenceModel" } } } ] }, "ChatVisibility": { "title": "ChatVisibility", "enum": [ "Show", "Hide" ], "type": "string" }, "ChatWebsiteWidgetChannelReferenceModel": { "title": "ChatWebsiteWidgetChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ChatExternalChannelReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ChatWelcomerChannelReferenceModel": { "title": "ChatWelcomerChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ChatInternalChannelReferenceBaseModel" }, { "type": "object", "properties": { "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelFilter" } ], "readOnly": true, "deprecated": true } }, "additionalProperties": false } ] }, "ChatWhatsappChannelReferenceBaseModel": { "title": "ChatWhatsappChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/ChatPhoneNumberChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ChatWhatsappChannelReferenceBaseModel": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel", "ChatBrokerWhatsappChannelReferenceModel": "#/components/schemas/ChatBrokerWhatsappChannelReferenceModel", "ChatGupshupWhatsappChannelReferenceModel": "#/components/schemas/ChatGupshupWhatsappChannelReferenceModel", "ChatCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/ChatCloudAPIWhatsappChannelReferenceModel" } } } ] }, "ChatbotModel": { "title": "ChatbotModel", "required": [ "botId", "organizationId", "triggerName" ], "type": "object", "properties": { "chatId": { "type": "string", "description": "The Id of the chat to start the bot in. When provided, ToPhone and FromPhone must be omitted", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "toPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "The phone number of the channel that should be used to start the bot. When provided, ChatId must be omitted and FromPhone must also be filled", "nullable": true, "example": "+5511987654321" }, "fromPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "The phone number of the contact that should be used to start the bot. When provided, ChatId must be omitted and ToPhone must also be filled", "nullable": true, "example": "+5511987654321" }, "botId": { "type": "string", "description": "The Id of the bot. Must be of the flowchart type", "example": "AB_12-xyzEXAMPLE" }, "triggerName": { "minLength": 1, "type": "string", "description": "The name of the trigger to start from within the bot" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "bulkSession": { "type": "string", "description": "Used to group messages by a bulk send session", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "contactName": { "type": "string", "description": "An optional name to create the contact with if it does not exist. Will be ignored if the contact already exists", "nullable": true }, "initialData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Class related to the variables set during the bot's creation.", "nullable": true }, "parallel": { "type": "boolean", "description": "Determines when bot will execute in parellel.", "nullable": true } }, "additionalProperties": false }, "ChatbotRunningBehaviorModel": { "title": "ChatbotRunningBehaviorModel", "type": "object", "properties": { "behavior": { "allOf": [ { "$ref": "#/components/schemas/ChatbotRunningBehaviors" } ] } }, "additionalProperties": false }, "ChatbotRunningBehaviors": { "title": "ChatbotRunningBehaviors", "enum": [ "ConfirmStopChatbot", "JustStopChatbot" ], "type": "string" }, "CloneKnowledgeBaseModel": { "title": "CloneKnowledgeBaseModel", "required": [ "fromAgentId", "toAgentId" ], "type": "object", "properties": { "fromAgentId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "toAgentId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CloseChatActionModel": { "title": "CloseChatActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "type": "object", "properties": { "closedByAs": { "allOf": [ { "$ref": "#/components/schemas/CloseChatActionSetClosedByAs" } ] } }, "additionalProperties": false } ] }, "CloseChatActionSetClosedByAs": { "title": "CloseChatActionSetClosedByAs", "enum": [ "NoOne", "ChatOwner" ], "type": "string" }, "CloseChatBehaviorModel": { "title": "CloseChatBehaviorModel", "type": "object", "properties": { "behavior": { "allOf": [ { "$ref": "#/components/schemas/CloseChatBehaviors" } ] }, "message": { "type": "string", "nullable": true }, "bot": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ], "nullable": true }, "memberCanChooseBot": { "type": "boolean" }, "memberCanChooseSendMessage": { "type": "boolean" }, "memberCanChooseTemplate": { "type": "boolean" }, "template": { "allOf": [ { "$ref": "#/components/schemas/TemplatePreference" } ], "nullable": true } }, "additionalProperties": false }, "CloseChatBehaviors": { "title": "CloseChatBehaviors", "enum": [ "MemberDecides", "JustClose", "SendMessage", "ExecuteBot" ], "type": "string" }, "CloserAgentReferenceModel": { "title": "CloserAgentReferenceModel", "allOf": [ { "$ref": "#/components/schemas/AgentReferenceModel" }, { "type": "object", "properties": { "profilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" } }, "additionalProperties": false } ] }, "CloudAPIWhatsappChannelModel": { "title": "CloudAPIWhatsappChannelModel", "allOf": [ { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ClusterState": { "title": "ClusterState", "enum": [ "Available", "Unavailable", "Deactivated" ], "type": "string" }, "CommentBlockModel": { "title": "CommentBlockModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "type": "object", "properties": { "comment": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "CommunicationStyles": { "title": "CommunicationStyles", "enum": [ "Regular", "Formal", "Informal" ], "type": "string" }, "CommunicationToneOption": { "title": "CommunicationToneOption", "enum": [ "Formal", "Professional", "Casual", "Relaxed" ], "type": "string" }, "ConditionalActionModel": { "title": "ConditionalActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "type": "object", "properties": { "strategy": { "allOf": [ { "$ref": "#/components/schemas/MatchStrategy" } ] }, "onSuccess": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "conditionalGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalGroupModel" } } }, "additionalProperties": false } ] }, "ConditionalGroupModel": { "title": "ConditionalGroupModel", "type": "object", "properties": { "conditionals": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "$ref": "#/components/schemas/ContactCustomFieldConditionalModel" }, { "$ref": "#/components/schemas/ContactActiveConditionalModel" }, { "$ref": "#/components/schemas/ContactGroupConditionalModel" }, { "$ref": "#/components/schemas/FirstChatInChannelConditionalModel" }, { "$ref": "#/components/schemas/ChannelConditionalModel" }, { "$ref": "#/components/schemas/MemberConditionalModel" }, { "$ref": "#/components/schemas/SectorConditionalModel" }, { "$ref": "#/components/schemas/TagConditionalModel" }, { "$ref": "#/components/schemas/DataConditionalModel" }, { "$ref": "#/components/schemas/BusinessHourConditionalModel" } ] } }, "onSuccess": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConditionalModel": { "title": "ConditionalModel", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "operator": { "allOf": [ { "$ref": "#/components/schemas/ConditionalOperator" } ] } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ConditionalModel": "#/components/schemas/ConditionalModel", "ContactCustomFieldConditionalModel": "#/components/schemas/ContactCustomFieldConditionalModel", "ContactActiveConditionalModel": "#/components/schemas/ContactActiveConditionalModel", "ContactGroupConditionalModel": "#/components/schemas/ContactGroupConditionalModel", "FirstChatInChannelConditionalModel": "#/components/schemas/FirstChatInChannelConditionalModel", "ChannelConditionalModel": "#/components/schemas/ChannelConditionalModel", "MemberConditionalModel": "#/components/schemas/MemberConditionalModel", "SectorConditionalModel": "#/components/schemas/SectorConditionalModel", "TagConditionalModel": "#/components/schemas/TagConditionalModel", "DataConditionalModel": "#/components/schemas/DataConditionalModel", "BusinessHourConditionalModel": "#/components/schemas/BusinessHourConditionalModel" } } }, "ConditionalOperator": { "title": "ConditionalOperator", "enum": [ "Equals", "NotEquals", "GreaterThan", "LessThan", "Exists", "NotExists", "Contains", "NotContains", "Any", "NotAny", "None", "StartsWith", "EndsWith", "RegexMatch" ], "type": "string" }, "ContactActiveConditionalModel": { "title": "ContactActiveConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false } ] }, "ContactCNPJCustomFieldModel": { "title": "ContactCNPJCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } }, "additionalProperties": false } ] }, "ContactCPFCustomFieldModel": { "title": "ContactCPFCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } }, "additionalProperties": false } ] }, "ContactCurrencyCustomFieldModel": { "title": "ContactCurrencyCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "decimal" } }, "additionalProperties": false } ] }, "ContactCustomFieldConditionalModel": { "title": "ContactCustomFieldConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "custonFieldDefinitionId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "contactFieldDefinition": { "allOf": [ { "$ref": "#/components/schemas/ContactFieldConditionalModel" } ], "nullable": true } }, "additionalProperties": false } ] }, "ContactCustomFieldModel": { "title": "ContactCustomFieldModel", "required": [ "_t", "customFieldDefinitionId", "id" ], "type": "object", "properties": { "_t": { "type": "string" }, "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "customFieldDefinitionId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ContactCustomFieldModel": "#/components/schemas/ContactCustomFieldModel", "ContactCurrencyCustomFieldModel": "#/components/schemas/ContactCurrencyCustomFieldModel", "ContactTextCustomFieldModel": "#/components/schemas/ContactTextCustomFieldModel", "ContactLinkCustomFieldModel": "#/components/schemas/ContactLinkCustomFieldModel", "ContactLogicCustomFieldModel": "#/components/schemas/ContactLogicCustomFieldModel", "ContactNumberCustomFieldModel": "#/components/schemas/ContactNumberCustomFieldModel", "ContactCNPJCustomFieldModel": "#/components/schemas/ContactCNPJCustomFieldModel", "ContactCPFCustomFieldModel": "#/components/schemas/ContactCPFCustomFieldModel", "ContactDateCustomFieldModel": "#/components/schemas/ContactDateCustomFieldModel", "ContactDecimalCustomFieldModel": "#/components/schemas/ContactDecimalCustomFieldModel", "ContactListStringCustomFieldModel": "#/components/schemas/ContactListStringCustomFieldModel" } } }, "ContactDateCustomFieldModel": { "title": "ContactDateCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } }, "additionalProperties": false } ] }, "ContactDecimalCustomFieldModel": { "title": "ContactDecimalCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "decimal" } }, "additionalProperties": false } ] }, "ContactFieldConditionalModel": { "title": "ContactFieldConditionalModel", "enum": [ "Name", "Landline", "Email", "Gender", "PhoneNumber" ], "type": "string" }, "ContactFieldDefinition": { "title": "ContactFieldDefinition", "enum": [ "Name", "Landline", "Email", "Gender", "AddressLine1", "AddressLine2", "AddressCity", "AddressState", "AddressZipCode", "AddressCountry" ], "type": "string" }, "ContactGroupConditionalModel": { "title": "ContactGroupConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "isGroup": { "type": "boolean" } }, "additionalProperties": false } ] }, "ContactLinkCustomFieldModel": { "title": "ContactLinkCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } }, "additionalProperties": false } ] }, "ContactListStringCustomFieldModel": { "title": "ContactListStringCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "ContactLogicCustomFieldModel": { "title": "ContactLogicCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "boolean" } }, "additionalProperties": false } ] }, "ContactModel": { "title": "ContactModel", "allOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "required": [ "notes" ], "type": "object", "properties": { "landline": { "type": "string", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/AddressModel" } ], "nullable": true }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/NoteModel" } }, "customFields": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/ContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/ContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/ContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/ContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/ContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/ContactListStringCustomFieldModel" } ] } } }, "additionalProperties": false } ] }, "ContactNumberCustomFieldModel": { "title": "ContactNumberCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false } ] }, "ContactPreferenceModel": { "title": "ContactPreferenceModel", "type": "object", "properties": { "category": { "type": "string", "description": "Values can be:\n marketing_messages - Indicates the template acceptance.", "nullable": true }, "value": { "type": "string", "description": "Values can be:\n stop — Indicates the WhatsApp users has opted to stop receiving marketing messages from you.\n resume — Indicates the WhatsApp users has opted to resume receiving marketing messages from you.", "nullable": true }, "eventAtUTC": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ContactProperty": { "title": "ContactProperty", "enum": [ "Name", "PhoneNumber", "Email", "LastActiveUTC", "CreatedAtUTC" ], "type": "string" }, "ContactRatingProperty": { "title": "ContactRatingProperty", "enum": [ "CreatedAtUTC", "Rating", "Repository", "Feedback" ], "type": "string" }, "ContactRatingSimplifiedModel": { "title": "ContactRatingSimplifiedModel", "type": "object", "properties": { "rating": { "allOf": [ { "$ref": "#/components/schemas/ScoreRating" } ] }, "dateUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ContactRatingsModel": { "title": "ContactRatingsModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "chat", "contact", "repository" ], "type": "object", "properties": { "chat": { "allOf": [ { "$ref": "#/components/schemas/ChatIdReferenceModel" } ] }, "contact": { "allOf": [ { "$ref": "#/components/schemas/ContactReferenceIdModel" } ] }, "repository": { "type": "string" }, "rating": { "allOf": [ { "$ref": "#/components/schemas/ScoreRating" } ] }, "feedback": { "type": "string", "nullable": true }, "botReference": { "allOf": [ { "$ref": "#/components/schemas/BotInstanceStepReferenceModel" } ], "nullable": true } }, "additionalProperties": false } ] }, "ContactReferenceIdModel": { "title": "ContactReferenceIdModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ContactReferenceModel": { "title": "ContactReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceNullableNameBaseModel" }, { "type": "object", "properties": { "lastActiveUTC": { "type": "string", "format": "date-time", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "profilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "isBlocked": { "type": "boolean" }, "scheduledMessages": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledMessageReferenceModel" } }, "groupIdentifier": { "type": "string", "nullable": true }, "contactType": { "allOf": [ { "$ref": "#/components/schemas/ContactType" } ] }, "tags": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SimpleTagReferenceModel" }, { "$ref": "#/components/schemas/TagModel" } ] } }, "preferences": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPreferenceModel" } } }, "additionalProperties": false } ] }, "ContactSaveModel": { "title": "ContactSaveModel", "required": [ "contact" ], "type": "object", "properties": { "contact": { "allOf": [ { "$ref": "#/components/schemas/ContactModel" } ] }, "alreadyExisted": { "type": "boolean" } }, "additionalProperties": false }, "ContactState": { "title": "ContactState", "enum": [ "All", "Blocked", "Active" ], "type": "string" }, "ContactTextCustomFieldModel": { "title": "ContactTextCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/ContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } }, "additionalProperties": false } ] }, "ContactType": { "title": "ContactType", "enum": [ "DirectMessage", "Group", "MemberDirectMessage", "MemberGroup" ], "type": "string" }, "ContactsBoardColumnModel": { "title": "ContactsBoardColumnModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagReferenceIdModel" } }, "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/ContactsBoardCustomFieldModel" } } }, "additionalProperties": false } ] }, "ContactsBoardCustomFieldModel": { "title": "ContactsBoardCustomFieldModel", "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "customFieldDefinitionId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "aggregationType": { "allOf": [ { "$ref": "#/components/schemas/AggregationType" } ] } }, "additionalProperties": false }, "ContactsBoardModel": { "title": "ContactsBoardModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/ContactsBoardColumnModel" } } }, "additionalProperties": false } ] }, "ContainerReferenceModel": { "title": "ContainerReferenceModel", "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "inUseAtUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ContainerState": { "title": "ContainerState", "enum": [ "PrePool", "Pool", "InUse", "Canceled" ], "type": "string" }, "ContainerStatus": { "title": "ContainerStatus", "enum": [ "Up", "Down" ], "type": "string" }, "ContractPlan": { "title": "ContractPlan", "enum": [ "Basic", "Professional", "Enterprise", "Free" ], "type": "string" }, "ContractStatus": { "title": "ContractStatus", "enum": [ "AwaitingPayment", "AwaitingRelease", "AwaitingReactivation", "Active", "AwaitingDeactivation", "Inactive", "Canceled", "PreCanceled", "Deleted", "Paused", "AwaitingSubscription", "Suspended", "Free" ], "type": "string" }, "ConversationPaceOption": { "title": "ConversationPaceOption", "enum": [ "Dynamic", "Natural", "Balanced", "Detailed", "Analytical" ], "type": "string" }, "CountryRequiredEditAddressModel": { "title": "CountryRequiredEditAddressModel", "allOf": [ { "$ref": "#/components/schemas/EditAddressModel" }, { "required": [ "country" ], "type": "object", "properties": { "country": { "minLength": 1, "type": "string" } }, "additionalProperties": false } ] }, "CreateAIAgentModel": { "title": "CreateAIAgentModel", "required": [ "aiBotLocale", "botLLM", "chatbotType", "communicationStyle", "displayName", "organizationId", "organizationIndustry", "organizationName", "voiceId" ], "type": "object", "properties": { "displayName": { "maxLength": 128, "minLength": 1, "type": "string" }, "signature": { "maxLength": 128, "type": "string", "nullable": true }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "organizationName": { "maxLength": 128, "minLength": 1, "type": "string" }, "organizationWebsite": { "maxLength": 256, "type": "string", "nullable": true }, "communicationStyle": { "allOf": [ { "$ref": "#/components/schemas/CommunicationStyles" } ] }, "chatbotType": { "allOf": [ { "$ref": "#/components/schemas/BotTypes" } ] }, "generalPrompt": { "maxLength": 8000, "type": "string", "nullable": true }, "autoGeneratedPrompt": { "type": "string", "nullable": true }, "selectedFunctionKey": { "type": "string", "nullable": true }, "intents": { "maxItems": 12, "type": "array", "items": { "$ref": "#/components/schemas/CreateAiIntentModel" } }, "mcpTools": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateAiMcpToolModel" }, { "$ref": "#/components/schemas/CreateGoogleCalendarMcpTool" }, { "$ref": "#/components/schemas/CreateExternalApiMcpTool" }, { "$ref": "#/components/schemas/CreateGoogleSheetsMcpTool" } ] } }, "stages": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/CreateAiStageModel" } }, "organizationIndustry": { "maxLength": 128, "minLength": 1, "type": "string" }, "botLLM": { "allOf": [ { "$ref": "#/components/schemas/AiLLMs" } ] }, "maxResponses": { "maximum": 150, "minimum": 1, "type": "integer", "format": "int32" }, "maxCharacterByResponses": { "type": "integer", "format": "int32" }, "replyAfterTransfer": { "type": "boolean" }, "inactivityWindowToReply": { "maximum": 90, "minimum": 3, "type": "integer", "format": "int32" }, "replyInAudio": { "allOf": [ { "$ref": "#/components/schemas/ReplyInAudio" } ] }, "agentIdentityStyle": { "allOf": [ { "$ref": "#/components/schemas/AgentIdentityOption" } ] }, "conversationPace": { "allOf": [ { "$ref": "#/components/schemas/ConversationPaceOption" } ] }, "communicationTone": { "allOf": [ { "$ref": "#/components/schemas/CommunicationToneOption" } ] }, "emojiUsage": { "allOf": [ { "$ref": "#/components/schemas/EmojiUsageOption" } ] }, "voiceId": { "minLength": 1, "type": "string" }, "aiBotLocale": { "allOf": [ { "$ref": "#/components/schemas/AILocale" } ] }, "llmTemperature": { "maximum": 1, "minimum": 0, "type": "number", "format": "float" }, "allowedCustomFields": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "nullable": true }, "invalidMessageIntent": { "allOf": [ { "$ref": "#/components/schemas/AiIntentModel" } ], "nullable": true }, "maxResponsesIntent": { "allOf": [ { "$ref": "#/components/schemas/AiIntentModel" } ], "nullable": true } }, "additionalProperties": false }, "CreateAIAgentQAModel": { "title": "CreateAIAgentQAModel", "required": [ "content", "title" ], "type": "object", "properties": { "title": { "maxLength": 256, "minLength": 1, "type": "string" }, "content": { "maxLength": 65536, "minLength": 1, "type": "string" }, "kbId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAIAgentWebsiteCrawlerModel": { "title": "CreateAIAgentWebsiteCrawlerModel", "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://example.com" }, "recursive": { "type": "boolean" }, "kbId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAiIntentModel": { "title": "CreateAiIntentModel", "required": [ "action", "description" ], "type": "object", "properties": { "description": { "maxLength": 1000, "minLength": 1, "type": "string" }, "action": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ] }, "replyAfterExecuteTool": { "type": "boolean" }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "CreateAiMcpToolModel": { "title": "CreateAiMcpToolModel", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateAiMcpToolModel": "#/components/schemas/CreateAiMcpToolModel", "CreateGoogleCalendarMcpTool": "#/components/schemas/CreateGoogleCalendarMcpTool", "CreateExternalApiMcpTool": "#/components/schemas/CreateExternalApiMcpTool", "CreateGoogleSheetsMcpTool": "#/components/schemas/CreateGoogleSheetsMcpTool" } } }, "CreateAiStageModel": { "title": "CreateAiStageModel", "required": [ "actionDescription", "name" ], "type": "object", "properties": { "name": { "maxLength": 250, "minLength": 1, "type": "string" }, "actionDescription": { "maxLength": 1000, "minLength": 1, "type": "string" }, "botAddedDateUTC": { "type": "string", "format": "date-time", "nullable": true }, "triggerBot": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ], "nullable": true } }, "additionalProperties": false }, "CreateAsaasActionModel": { "title": "CreateAsaasActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateWebhookActionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateBotBase": { "title": "CreateBotBase", "required": [ "_t", "channelIds", "organizationId", "title" ], "type": "object", "properties": { "_t": { "type": "string" }, "channelIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "description": "A list of all the channels this bot will act upon" }, "trigger": { "allOf": [ { "$ref": "#/components/schemas/BotTrigger" } ] }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "title": { "minLength": 1, "type": "string", "description": "The title of this bot, for internal reference only" }, "order": { "type": "number", "description": "The order this bot should be put alongside others when executing", "format": "float" }, "final": { "type": "boolean", "description": "When true, will prevent the execution of further bots on the channel if this bot decides it should execute" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "description": "The list of group IDs for this bot." }, "snapshotTitle": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateBotBase": "#/components/schemas/CreateBotBase", "CreateFlowchartBotModel": "#/components/schemas/CreateFlowchartBotModel" } } }, "CreateBotOptionModel": { "title": "CreateBotOptionModel", "allOf": [ { "$ref": "#/components/schemas/GenericOptionModel" }, { "required": [ "text" ], "type": "object", "properties": { "text": { "minLength": 1, "type": "string" } }, "additionalProperties": false } ] }, "CreateBotShortcutModel": { "title": "CreateBotShortcutModel", "required": [ "actionTitle", "bot", "icon", "organizationId" ], "type": "object", "properties": { "icon": { "minLength": 1, "pattern": "^ph-[a-z-]+$", "type": "string" }, "actionTitle": { "maxLength": 60, "minLength": 1, "type": "string" }, "bot": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ] }, "allowEditOnBotSend": { "type": "boolean" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateBulkSendSessionModel": { "title": "CreateBulkSendSessionModel", "required": [ "channelId", "expectedMessages", "organizationId", "title" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "channelId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "title": { "maxLength": 128, "minLength": 3, "type": "string" }, "expectedMessages": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "botId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "triggerName": { "type": "string", "nullable": true }, "templateId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateCNPJCustomFieldDefinitionModel": { "title": "CreateCNPJCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateCPFCustomFieldDefinitionModel": { "title": "CreateCPFCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateChangeChatPrivateStateActionModel": { "title": "CreateChangeChatPrivateStateActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "type": "object", "properties": { "private": { "type": "boolean" } }, "additionalProperties": false } ] }, "CreateChatModel": { "title": "CreateChatModel", "required": [ "channelId", "contactId", "organizationId" ], "type": "object", "properties": { "contactId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "channelId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateChatVisibilityActionModel": { "title": "CreateChatVisibilityActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "required": [ "visibility" ], "type": "object", "properties": { "visibility": { "allOf": [ { "$ref": "#/components/schemas/ChatVisibility" } ] } }, "additionalProperties": false } ] }, "CreateCloseChatActionModel": { "title": "CreateCloseChatActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "type": "object", "properties": { "closedByAs": { "allOf": [ { "$ref": "#/components/schemas/CloseChatActionSetClosedByAs" } ] } }, "additionalProperties": false } ] }, "CreateCommentBlockModel": { "title": "CreateCommentBlockModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "type": "object", "properties": { "comment": { "maxLength": 2000, "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "CreateConditionalActionModel": { "title": "CreateConditionalActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "type": "object", "properties": { "strategy": { "allOf": [ { "$ref": "#/components/schemas/MatchStrategy" } ] }, "onSuccess": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "conditionalGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalGroupModel" } } }, "additionalProperties": false } ] }, "CreateContactCNPJCustomFieldModel": { "title": "CreateContactCNPJCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 18, "minLength": 14, "type": "string" } }, "additionalProperties": false } ] }, "CreateContactCPFCustomFieldModel": { "title": "CreateContactCPFCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 11, "minLength": 11, "type": "string" } }, "additionalProperties": false } ] }, "CreateContactCurrencyCustomFieldModel": { "title": "CreateContactCurrencyCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "decimal" } }, "additionalProperties": false } ] }, "CreateContactCustomFieldModel": { "title": "CreateContactCustomFieldModel", "required": [ "_t", "customFieldDefinitionId", "organizationId" ], "type": "object", "properties": { "_t": { "type": "string" }, "customFieldDefinitionId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateContactCustomFieldModel": "#/components/schemas/CreateContactCustomFieldModel", "CreateContactCurrencyCustomFieldModel": "#/components/schemas/CreateContactCurrencyCustomFieldModel", "CreateContactTextCustomFieldModel": "#/components/schemas/CreateContactTextCustomFieldModel", "CreateContactLinkCustomFieldModel": "#/components/schemas/CreateContactLinkCustomFieldModel", "CreateContactLogicCustomFieldModel": "#/components/schemas/CreateContactLogicCustomFieldModel", "CreateContactNumberCustomFieldModel": "#/components/schemas/CreateContactNumberCustomFieldModel", "CreateContactCNPJCustomFieldModel": "#/components/schemas/CreateContactCNPJCustomFieldModel", "CreateContactCPFCustomFieldModel": "#/components/schemas/CreateContactCPFCustomFieldModel", "CreateContactDateCustomFieldModel": "#/components/schemas/CreateContactDateCustomFieldModel", "CreateContactDecimalCustomFieldModel": "#/components/schemas/CreateContactDecimalCustomFieldModel", "CreateContactListStringCustomFieldModel": "#/components/schemas/CreateContactListStringCustomFieldModel" } } }, "CreateContactDateCustomFieldModel": { "title": "CreateContactDateCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } }, "additionalProperties": false } ] }, "CreateContactDecimalCustomFieldModel": { "title": "CreateContactDecimalCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "decimal" } }, "additionalProperties": false } ] }, "CreateContactLinkCustomFieldModel": { "title": "CreateContactLinkCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 1000, "minLength": 0, "type": "string" } }, "additionalProperties": false } ] }, "CreateContactListStringCustomFieldModel": { "title": "CreateContactListStringCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "CreateContactLogicCustomFieldModel": { "title": "CreateContactLogicCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "boolean" } }, "additionalProperties": false } ] }, "CreateContactModel": { "title": "CreateContactModel", "required": [ "organizationId", "phoneNumber" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phoneNumber": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "address": { "oneOf": [ { "$ref": "#/components/schemas/EditAddressModel" }, { "$ref": "#/components/schemas/RequiredEditAddressModel" }, { "$ref": "#/components/schemas/CountryRequiredEditAddressModel" } ], "nullable": true }, "landline": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "nullable": true, "example": "+5511987654321" }, "gender": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "profilePictureUrl": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "customFields": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCurrencyCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactTextCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactLinkCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactLogicCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactNumberCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCNPJCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactCPFCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactDateCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactDecimalCustomFieldModel" }, { "$ref": "#/components/schemas/CreateContactListStringCustomFieldModel" } ] }, "nullable": true } }, "additionalProperties": false }, "CreateContactNumberCustomFieldModel": { "title": "CreateContactNumberCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maximum": 9.223372036854776E+18, "minimum": -9.223372036854776E+18, "type": "integer", "format": "int64" } }, "additionalProperties": false } ] }, "CreateContactTextCustomFieldModel": { "title": "CreateContactTextCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/CreateContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 2000, "minLength": 0, "type": "string" } }, "additionalProperties": false } ] }, "CreateCurrencyCustomFieldDefinitionModel": { "title": "CreateCurrencyCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "properties": { "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyEnum" } ] }, "minRange": { "type": "number", "format": "decimal", "nullable": true }, "maxRange": { "type": "number", "format": "decimal", "nullable": true }, "scale": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "CreateCustomFieldDefinitionModel": { "title": "CreateCustomFieldDefinitionModel", "required": [ "_t", "name", "organizationId" ], "type": "object", "properties": { "_t": { "type": "string" }, "name": { "maxLength": 160, "minLength": 3, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "description": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateCustomFieldDefinitionModel": "#/components/schemas/CreateCustomFieldDefinitionModel", "CreateTextCustomFieldDefinitionModel": "#/components/schemas/CreateTextCustomFieldDefinitionModel", "CreateNumberCustomFieldDefinitionModel": "#/components/schemas/CreateNumberCustomFieldDefinitionModel", "CreateLinkCustomFieldDefinitionModel": "#/components/schemas/CreateLinkCustomFieldDefinitionModel", "CreateLogicCustomFieldDefinitionModel": "#/components/schemas/CreateLogicCustomFieldDefinitionModel", "CreateMemberCustomFieldDefinitionModel": "#/components/schemas/CreateMemberCustomFieldDefinitionModel", "CreateCNPJCustomFieldDefinitionModel": "#/components/schemas/CreateCNPJCustomFieldDefinitionModel", "CreateCPFCustomFieldDefinitionModel": "#/components/schemas/CreateCPFCustomFieldDefinitionModel", "CreateDateCustomFieldDefinitionModel": "#/components/schemas/CreateDateCustomFieldDefinitionModel", "CreateCurrencyCustomFieldDefinitionModel": "#/components/schemas/CreateCurrencyCustomFieldDefinitionModel", "CreateDecimalCustomFieldDefinitionModel": "#/components/schemas/CreateDecimalCustomFieldDefinitionModel", "CreateListStringCustomFieldDefinitionModel": "#/components/schemas/CreateListStringCustomFieldDefinitionModel" } } }, "CreateDateCustomFieldDefinitionModel": { "title": "CreateDateCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateDayOfTheWeekStepModel": { "title": "CreateDayOfTheWeekStepModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "stepsForDaysOfTheWeek", "timeZone" ], "type": "object", "properties": { "stepsForDaysOfTheWeek": { "maxItems": 7, "minItems": 7, "type": "array", "items": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "timeZone": { "type": "string", "description": "IANA timezone code", "format": "time-zone-id", "example": "America/Sao_Paulo" } }, "additionalProperties": false } ] }, "CreateDecimalCustomFieldDefinitionModel": { "title": "CreateDecimalCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "properties": { "minRange": { "type": "number", "format": "decimal", "nullable": true }, "maxRange": { "type": "number", "format": "decimal", "nullable": true }, "scale": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "CreateEncryptedVariableModel": { "title": "CreateEncryptedVariableModel", "allOf": [ { "$ref": "#/components/schemas/CreateVariableModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 500, "minLength": 1, "type": "string" } }, "additionalProperties": false } ] }, "CreateExternalApiMcpTool": { "title": "CreateExternalApiMcpTool", "allOf": [ { "$ref": "#/components/schemas/CreateAiMcpToolModel" }, { "type": "object", "properties": { "enableCaching": { "type": "boolean" }, "timeoutSeconds": { "type": "integer", "format": "int32" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/ApiEndpointModel" } }, "details": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "CreateFeedbackRatingStepModel": { "title": "CreateFeedbackRatingStepModel", "allOf": [ { "$ref": "#/components/schemas/CreateInteractiveStepModel" }, { "required": [ "nextStepId", "repository", "text" ], "type": "object", "properties": { "text": { "maxLength": 1000, "minLength": 1, "type": "string" }, "repository": { "maxLength": 50, "minLength": 1, "type": "string" }, "nextStepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "CreateFlowchartActionModel": { "title": "CreateFlowchartActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateFlowchartActionModel": "#/components/schemas/CreateFlowchartActionModel", "CreateTagActionModel": "#/components/schemas/CreateTagActionModel", "CreateSetWaitingStateActionModel": "#/components/schemas/CreateSetWaitingStateActionModel", "CreateSetInactivityActionModel": "#/components/schemas/CreateSetInactivityActionModel", "CreateSetWaitingFlowActionModel": "#/components/schemas/CreateSetWaitingFlowActionModel", "CreateChatVisibilityActionModel": "#/components/schemas/CreateChatVisibilityActionModel", "CreateSendMessageActionModel": "#/components/schemas/CreateSendMessageActionModel", "CreateChangeChatPrivateStateActionModel": "#/components/schemas/CreateChangeChatPrivateStateActionModel" } } } ] }, "CreateFlowchartBotChatStartedEventModel": { "title": "CreateFlowchartBotChatStartedEventModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotEventModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateFlowchartBotEventModel": { "title": "CreateFlowchartBotEventModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "_t", "nextStepId" ], "type": "object", "properties": { "_t": { "type": "string" }, "nextStepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateFlowchartBotEventModel": "#/components/schemas/CreateFlowchartBotEventModel", "CreateFlowchartBotManualStartedEventModel": "#/components/schemas/CreateFlowchartBotManualStartedEventModel", "CreateFlowchartBotChatStartedEventModel": "#/components/schemas/CreateFlowchartBotChatStartedEventModel" } } } ] }, "CreateFlowchartBotManualStartedEventModel": { "title": "CreateFlowchartBotManualStartedEventModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotEventModel" }, { "required": [ "triggerName", "variables" ], "type": "object", "properties": { "hidden": { "type": "boolean" }, "triggerName": { "minLength": 1, "type": "string" }, "variables": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/FlowchartVariableModel" }, { "$ref": "#/components/schemas/TextFlowchartVariableModel" }, { "$ref": "#/components/schemas/NumberFlowchartVariableModel" }, { "$ref": "#/components/schemas/TimeFlowchartVariableModel" }, { "$ref": "#/components/schemas/DateFlowchartVariableModel" }, { "$ref": "#/components/schemas/ListTextFlowchartVariableModel" } ] } } }, "additionalProperties": false } ] }, "CreateFlowchartBotModel": { "title": "CreateFlowchartBotModel", "allOf": [ { "$ref": "#/components/schemas/CreateBotBase" }, { "required": [ "steps" ], "type": "object", "properties": { "steps": { "minItems": 1, "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "$ref": "#/components/schemas/CreateTemplateMessageStepModel" }, { "$ref": "#/components/schemas/CreatePipedriveActionModel" }, { "$ref": "#/components/schemas/CreateAsaasActionModel" }, { "$ref": "#/components/schemas/CreateWebhookActionModel" }, { "$ref": "#/components/schemas/CreateOneShotCronActionModel" }, { "$ref": "#/components/schemas/CreateWaitingActionModel" }, { "$ref": "#/components/schemas/CreateTimeOfDayStepModel" }, { "$ref": "#/components/schemas/CreateTagActionModel" }, { "$ref": "#/components/schemas/CreateStartManualEntryActionModel" }, { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "$ref": "#/components/schemas/CreateFlowchartBotEventModel" }, { "$ref": "#/components/schemas/CreateInteractiveStepModel" }, { "$ref": "#/components/schemas/CreateSetWaitingStateActionModel" }, { "$ref": "#/components/schemas/CreateSetInactivityActionModel" }, { "$ref": "#/components/schemas/CreateSetWaitingFlowActionModel" }, { "$ref": "#/components/schemas/CreateSetCustomFieldActionModel" }, { "$ref": "#/components/schemas/CreateChatVisibilityActionModel" }, { "$ref": "#/components/schemas/CreateSendMessageActionModel" }, { "$ref": "#/components/schemas/CreateSectorTransferActionModel" }, { "$ref": "#/components/schemas/CreateRegexStepModel" }, { "$ref": "#/components/schemas/CreateFeedbackRatingStepModel" }, { "$ref": "#/components/schemas/CreateScoreRatingStepModel" }, { "$ref": "#/components/schemas/CreateOptionsStepModel" }, { "$ref": "#/components/schemas/CreateNotifyMemberActionModel" }, { "$ref": "#/components/schemas/CreateMemberTransferActionModel" }, { "$ref": "#/components/schemas/CreateFlowchartBotManualStartedEventModel" }, { "$ref": "#/components/schemas/CreateDayOfTheWeekStepModel" }, { "$ref": "#/components/schemas/CreateConditionalActionModel" }, { "$ref": "#/components/schemas/CreateCommentBlockModel" }, { "$ref": "#/components/schemas/CreateCloseChatActionModel" }, { "$ref": "#/components/schemas/CreateFlowchartBotChatStartedEventModel" }, { "$ref": "#/components/schemas/CreateChangeChatPrivateStateActionModel" } ] } } }, "additionalProperties": false } ] }, "CreateFlowchartBotStepModel": { "title": "CreateFlowchartBotStepModel", "required": [ "_t", "id", "position" ], "type": "object", "properties": { "_t": { "type": "string" }, "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "position": { "allOf": [ { "$ref": "#/components/schemas/PositionModel" } ] } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateFlowchartBotStepModel": "#/components/schemas/CreateFlowchartBotStepModel", "CreateTemplateMessageStepModel": "#/components/schemas/CreateTemplateMessageStepModel", "CreatePipedriveActionModel": "#/components/schemas/CreatePipedriveActionModel", "CreateAsaasActionModel": "#/components/schemas/CreateAsaasActionModel", "CreateWebhookActionModel": "#/components/schemas/CreateWebhookActionModel", "CreateOneShotCronActionModel": "#/components/schemas/CreateOneShotCronActionModel", "CreateWaitingActionModel": "#/components/schemas/CreateWaitingActionModel", "CreateTimeOfDayStepModel": "#/components/schemas/CreateTimeOfDayStepModel", "CreateTagActionModel": "#/components/schemas/CreateTagActionModel", "CreateStartManualEntryActionModel": "#/components/schemas/CreateStartManualEntryActionModel", "CreateFlowchartActionModel": "#/components/schemas/CreateFlowchartActionModel", "CreateFlowchartBotEventModel": "#/components/schemas/CreateFlowchartBotEventModel", "CreateInteractiveStepModel": "#/components/schemas/CreateInteractiveStepModel", "CreateSetWaitingStateActionModel": "#/components/schemas/CreateSetWaitingStateActionModel", "CreateSetInactivityActionModel": "#/components/schemas/CreateSetInactivityActionModel", "CreateSetWaitingFlowActionModel": "#/components/schemas/CreateSetWaitingFlowActionModel", "CreateSetCustomFieldActionModel": "#/components/schemas/CreateSetCustomFieldActionModel", "CreateChatVisibilityActionModel": "#/components/schemas/CreateChatVisibilityActionModel", "CreateSendMessageActionModel": "#/components/schemas/CreateSendMessageActionModel", "CreateSectorTransferActionModel": "#/components/schemas/CreateSectorTransferActionModel", "CreateRegexStepModel": "#/components/schemas/CreateRegexStepModel", "CreateFeedbackRatingStepModel": "#/components/schemas/CreateFeedbackRatingStepModel", "CreateScoreRatingStepModel": "#/components/schemas/CreateScoreRatingStepModel", "CreateOptionsStepModel": "#/components/schemas/CreateOptionsStepModel", "CreateNotifyMemberActionModel": "#/components/schemas/CreateNotifyMemberActionModel", "CreateMemberTransferActionModel": "#/components/schemas/CreateMemberTransferActionModel", "CreateFlowchartBotManualStartedEventModel": "#/components/schemas/CreateFlowchartBotManualStartedEventModel", "CreateDayOfTheWeekStepModel": "#/components/schemas/CreateDayOfTheWeekStepModel", "CreateConditionalActionModel": "#/components/schemas/CreateConditionalActionModel", "CreateCommentBlockModel": "#/components/schemas/CreateCommentBlockModel", "CreateCloseChatActionModel": "#/components/schemas/CreateCloseChatActionModel", "CreateFlowchartBotChatStartedEventModel": "#/components/schemas/CreateFlowchartBotChatStartedEventModel", "CreateChangeChatPrivateStateActionModel": "#/components/schemas/CreateChangeChatPrivateStateActionModel" } } }, "CreateGoogleCalendarMcpTool": { "title": "CreateGoogleCalendarMcpTool", "allOf": [ { "$ref": "#/components/schemas/CreateAiMcpToolModel" }, { "required": [ "availableCalendars" ], "type": "object", "properties": { "availableCalendars": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableCalendarModel" } }, "calendars": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarModel" } }, "refreshToken": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "CreateGoogleSheetsMcpTool": { "title": "CreateGoogleSheetsMcpTool", "allOf": [ { "$ref": "#/components/schemas/CreateAiMcpToolModel" }, { "type": "object", "properties": { "spreadsheets": { "type": "array", "items": { "$ref": "#/components/schemas/SpreadsheetModel" } } }, "additionalProperties": false } ] }, "CreateGroupModel": { "title": "CreateGroupModel", "required": [ "name", "organizationId" ], "type": "object", "properties": { "name": { "maxLength": 60, "minLength": 1, "type": "string" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateInteractiveStepModel": { "title": "CreateInteractiveStepModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "onResponseFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onTimeout": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "timeout": { "type": "string", "format": "time-span", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateInteractiveStepModel": "#/components/schemas/CreateInteractiveStepModel", "CreateTemplateMessageStepModel": "#/components/schemas/CreateTemplateMessageStepModel", "CreateRegexStepModel": "#/components/schemas/CreateRegexStepModel", "CreateFeedbackRatingStepModel": "#/components/schemas/CreateFeedbackRatingStepModel", "CreateScoreRatingStepModel": "#/components/schemas/CreateScoreRatingStepModel", "CreateOptionsStepModel": "#/components/schemas/CreateOptionsStepModel" } } } ] }, "CreateKnowledgeBaseRequestModel": { "title": "CreateKnowledgeBaseRequestModel", "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreateLinkCustomFieldDefinitionModel": { "title": "CreateLinkCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateListStringCustomFieldDefinitionModel": { "title": "CreateListStringCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateLogicCustomFieldDefinitionModel": { "title": "CreateLogicCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateMemberCustomFieldDefinitionModel": { "title": "CreateMemberCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateMemberTransferActionModel": { "title": "CreateMemberTransferActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "options" ], "type": "object", "properties": { "target": { "allOf": [ { "$ref": "#/components/schemas/MemberTransferTarget" } ] }, "options": { "allOf": [ { "$ref": "#/components/schemas/CreateMemberTransferModel" } ] }, "onlyMembersAvailable": { "type": "boolean" }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "CreateMemberTransferModel": { "title": "CreateMemberTransferModel", "type": "object", "properties": { "memberIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/MemberTransferStrategy" } ] } }, "additionalProperties": false }, "CreateMembersChatByContactIdModel": { "title": "CreateMembersChatByContactIdModel", "required": [ "contactId", "organizationId" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "contactId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateMembersChatModel": { "title": "CreateMembersChatModel", "required": [ "contactName", "organizationId" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "contactName": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreateMessageModel": { "title": "CreateMessageModel", "required": [ "chatId", "organizationId" ], "type": "object", "properties": { "tempId": { "type": "string", "description": "An Id generated by the client that is passed along when the message is comitted to the database and has the true id. Not necessary for fire-and-forget situations", "nullable": true }, "file": { "type": "string", "format": "binary", "nullable": true }, "prefix": { "type": "string", "description": "A prefix to be concatenated with the message. Used by the app to include the operator name. Not required", "nullable": true }, "message": { "maxLength": 2000, "type": "string", "description": "The message to send", "default": "Mensagem de teste", "nullable": true }, "chatId": { "type": "string", "description": "The Id of the chat to send the message to. Must exist and be open", "example": "AB_12-xyzEXAMPLE" }, "isPrivate": { "type": "boolean", "description": "Private messages are not sent to the contact, they function like an internal annotation", "default": false }, "previousMessageId": { "type": "string", "description": "Used by the app to ensure messages are sent in order. Not necessary", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "stickUrl": { "type": "string", "description": "If the message you're sendind is a sticker, here you put its URL", "format": "uri", "nullable": true, "example": "https://example.com" }, "replyToMessageId": { "type": "string", "description": "When the message you're sending is a reply to another message, use the other message's Id here", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "skipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false }, "automated": { "type": "boolean", "description": "When true, indicates that the message was sent by an automated system. Currently, disables the behavior where sending a message stops bots from running.\nThis settings is experimental and may change in the future.", "default": false }, "fileId": { "type": "string", "description": "The file id that has already been saved in the organization files.", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "contacts": { "type": "string", "nullable": true }, "elements": { "type": "string", "nullable": true }, "mentions": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateMessageSimplifiedModel": { "title": "CreateMessageSimplifiedModel", "required": [ "fromPhone", "organizationId", "toPhone" ], "type": "object", "properties": { "toPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "fromPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "message": { "maxLength": 2000, "type": "string", "default": "Mensagem de teste", "nullable": true }, "file": { "type": "string", "format": "binary", "nullable": true }, "skipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false }, "contactName": { "type": "string", "description": "An optional name to create the contact with if it does not exist. Will be ignored if the contact already exists", "nullable": true } }, "additionalProperties": false }, "CreateNoteModel": { "title": "CreateNoteModel", "required": [ "content", "organizationId" ], "type": "object", "properties": { "content": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "elements": { "type": "string", "description": "Stores the JSON-serialized content of the RichTextEditor component.", "nullable": true }, "mentions": { "type": "string", "description": "Represents the JSON-serialized list of operator mentions within the note.", "nullable": true } }, "additionalProperties": false }, "CreateNotifyMemberActionModel": { "title": "CreateNotifyMemberActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "message", "options", "title" ], "type": "object", "properties": { "title": { "maxLength": 60, "minLength": 1, "type": "string" }, "message": { "maxLength": 1024, "minLength": 1, "type": "string" }, "options": { "allOf": [ { "$ref": "#/components/schemas/CreateNotifyMemberModel" } ] }, "onlyMembersAvailable": { "type": "boolean" }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "CreateNotifyMemberModel": { "title": "CreateNotifyMemberModel", "type": "object", "properties": { "memberIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/NotifyMemberStrategy" } ] } }, "additionalProperties": false }, "CreateNumberCustomFieldDefinitionModel": { "title": "CreateNumberCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateOneShotCronActionModel": { "title": "CreateOneShotCronActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "expression", "nextStepId", "timeZone" ], "type": "object", "properties": { "expression": { "minLength": 1, "type": "string" }, "nextStepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "contactResponseStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "timeZone": { "type": "string", "description": "IANA timezone code", "format": "time-zone-id", "example": "America/Sao_Paulo" } }, "additionalProperties": false } ] }, "CreateOptionsStepModel": { "title": "CreateOptionsStepModel", "allOf": [ { "$ref": "#/components/schemas/CreateInteractiveStepModel" }, { "required": [ "text" ], "type": "object", "properties": { "options": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CreateBotOptionModel" } }, "text": { "maxLength": 1024, "minLength": 1, "type": "string" }, "defaultNextStep": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "messageType": { "allOf": [ { "$ref": "#/components/schemas/MessageTypes" } ], "nullable": true } }, "additionalProperties": false } ] }, "CreatePipedriveActionModel": { "title": "CreatePipedriveActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateWebhookActionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreatePlainTextVariableModel": { "title": "CreatePlainTextVariableModel", "allOf": [ { "$ref": "#/components/schemas/CreateVariableModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 500, "minLength": 1, "type": "string" } }, "additionalProperties": false } ] }, "CreateQAsFromChatsModel": { "title": "CreateQAsFromChatsModel", "required": [ "organizationId" ], "type": "object", "properties": { "organizationId": { "type": "string", "description": "The Id of the organization. A list of all your organizations can be retrieved using the GET /v1/members/me route. A valid id can look like this: YiwUPDF2zFWaRG01", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateQuickAnswerModel": { "title": "CreateQuickAnswerModel", "required": [ "content", "name", "organizationId", "visibility" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "name": { "maxLength": 160, "minLength": 0, "type": "string" }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/QuickAnswerVisibility" } ] }, "content": { "maxLength": 2000, "minLength": 0, "type": "string" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "CreateRegexOptionModel": { "title": "CreateRegexOptionModel", "allOf": [ { "$ref": "#/components/schemas/GenericOptionModel" }, { "required": [ "pattern" ], "type": "object", "properties": { "pattern": { "maxLength": 512, "minLength": 1, "type": "string" }, "target": { "allOf": [ { "$ref": "#/components/schemas/RegexOptionTarget" } ] } }, "additionalProperties": false } ] }, "CreateRegexStepModel": { "title": "CreateRegexStepModel", "allOf": [ { "$ref": "#/components/schemas/CreateInteractiveStepModel" }, { "type": "object", "properties": { "options": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CreateRegexOptionModel" } }, "text": { "maxLength": 1024, "type": "string", "nullable": true }, "canUseLastMessage": { "type": "boolean" }, "sendMessage": { "type": "boolean" } }, "additionalProperties": false } ] }, "CreateScheduledMessageModel": { "title": "CreateScheduledMessageModel", "required": [ "dateSendAtUTC", "organizationId" ], "type": "object", "properties": { "dateSendAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "message": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "channelId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "contactId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "toPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "Represents the phone number of the contact. This property must be provided \nwhen Umbler.UTalk.Core.Models.SchedulerMessage.CreateScheduledMessageModel.ContactId is not specified.", "nullable": true, "example": "+5511987654321" }, "fromPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "Represents the phone number of the channel. This property must be provided \nwhen Umbler.UTalk.Core.Models.SchedulerMessage.CreateScheduledMessageModel.ChannelId is not specified.", "nullable": true, "example": "+5511987654321" }, "templateId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "templateLabel": { "type": "string", "nullable": true }, "botId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "botTriggerName": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true }, "params": { "maxLength": 1024, "minLength": 1, "type": "array", "items": { "type": "string" }, "nullable": true }, "cancelUpon": { "type": "array", "items": { "$ref": "#/components/schemas/CancelScheduledMessageUpon" } }, "initialData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "contactName": { "type": "string", "nullable": true }, "bulkSession": { "type": "string", "description": "Used to group messages by a bulk send session", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "isPrivate": { "type": "boolean", "description": "Private messages are not sent to the contact, they function like an internal annotation", "default": false }, "postbackTexts": { "type": "string", "description": "JSON string representing the list of postback texts associated with quick reply buttons.", "nullable": true } }, "additionalProperties": false }, "CreateScoreRatingOptionModel": { "title": "CreateScoreRatingOptionModel", "required": [ "rating", "stepId", "text" ], "type": "object", "properties": { "text": { "maxLength": 24, "minLength": 1, "type": "string" }, "stepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "rating": { "allOf": [ { "$ref": "#/components/schemas/ScoreRating" } ] }, "emoji": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateScoreRatingStepModel": { "title": "CreateScoreRatingStepModel", "allOf": [ { "$ref": "#/components/schemas/CreateInteractiveStepModel" }, { "required": [ "options", "repository", "text" ], "type": "object", "properties": { "options": { "maxItems": 5, "minItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/CreateScoreRatingOptionModel" } }, "text": { "maxLength": 1000, "minLength": 1, "type": "string" }, "repository": { "maxLength": 50, "minLength": 1, "type": "string" }, "orderBy": { "allOf": [ { "$ref": "#/components/schemas/ScoreRatingOrderBy" } ], "nullable": true }, "messageType": { "allOf": [ { "$ref": "#/components/schemas/MessageTypes" } ], "nullable": true } }, "additionalProperties": false } ] }, "CreateSectorModel": { "title": "CreateSectorModel", "required": [ "name", "organizationId" ], "type": "object", "properties": { "name": { "maxLength": 24, "minLength": 1, "type": "string" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "CreateSectorTransferActionModel": { "title": "CreateSectorTransferActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "type": "object", "properties": { "sectorId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/SectorTransferStrategy" } ] }, "onlyAllowedMember": { "type": "boolean" }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "CreateSendMessageActionModel": { "title": "CreateSendMessageActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "type": "object", "properties": { "organizationFileId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "message": { "maxLength": 1024, "type": "string", "nullable": true }, "isPrivate": { "type": "boolean" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/MessageButtonModel" } } }, "additionalProperties": false } ] }, "CreateSetCustomFieldActionGroupsModel": { "title": "CreateSetCustomFieldActionGroupsModel", "type": "object", "properties": { "contactFieldDefinition": { "allOf": [ { "$ref": "#/components/schemas/ContactFieldDefinition" } ], "nullable": true }, "customFieldDefinitionId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "value": { "type": "string", "nullable": true }, "parseCulture": { "type": "string", "description": "The Language Code ID", "format": "culture-info-id", "nullable": true, "example": "pt-BR" } }, "additionalProperties": false }, "CreateSetCustomFieldActionModel": { "title": "CreateSetCustomFieldActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "type": "object", "properties": { "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "customFieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/CreateSetCustomFieldActionGroupsModel" } } }, "additionalProperties": false } ] }, "CreateSetInactivityActionModel": { "title": "CreateSetInactivityActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "required": [ "hasInactivity" ], "type": "object", "properties": { "hasInactivity": { "type": "boolean" } }, "additionalProperties": false } ] }, "CreateSetWaitingFlowActionModel": { "title": "CreateSetWaitingFlowActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "required": [ "hasWaitingFlow" ], "type": "object", "properties": { "hasWaitingFlow": { "type": "boolean" } }, "additionalProperties": false } ] }, "CreateSetWaitingStateActionModel": { "title": "CreateSetWaitingStateActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "required": [ "waiting" ], "type": "object", "properties": { "waiting": { "type": "boolean" } }, "additionalProperties": false } ] }, "CreateStartManualEntryActionModel": { "title": "CreateStartManualEntryActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "botId", "manualEventId" ], "type": "object", "properties": { "botId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "manualEventId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "initialData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "schedule": { "allOf": [ { "$ref": "#/components/schemas/StartManualEntryActionScheduleModel" } ], "nullable": true }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "channelId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "parallel": { "type": "boolean", "nullable": true } }, "additionalProperties": false } ] }, "CreateStarterChannelModel": { "title": "CreateStarterChannelModel", "required": [ "displayName", "organizationId" ], "type": "object", "properties": { "displayName": { "minLength": 1, "type": "string" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateStickerModel": { "title": "CreateStickerModel", "required": [ "organizationId", "url" ], "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://example.com" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateTagActionModel": { "title": "CreateTagActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "type": "object", "properties": { "option": { "allOf": [ { "$ref": "#/components/schemas/TagActionOption" } ], "nullable": true }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "contactTags": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "CreateTagModel": { "title": "CreateTagModel", "required": [ "name", "organizationId" ], "type": "object", "properties": { "name": { "maxLength": 30, "minLength": 1, "pattern": "^[a-zA-Z\\u00C0-\\u00FF 0-9]{1,}$", "type": "string" }, "emoji": { "pattern": "(\\u00a9|\\u00ae|[\\u2000-\\u3300]|\\ud83c[\\ud000-\\udfff]|\\ud83d[\\ud000-\\udfff]|\\ud83e[\\ud000-\\udfff])?", "type": "string", "nullable": true }, "color": { "allOf": [ { "$ref": "#/components/schemas/TagColor" } ] }, "description": { "maxLength": 2048, "type": "string", "nullable": true }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "CreateTemplateButtonModel": { "title": "CreateTemplateButtonModel", "required": [ "text", "type" ], "type": "object", "properties": { "text": { "maxLength": 25, "minLength": 1, "type": "string" }, "otpType": { "type": "string", "nullable": true }, "autofillText": { "maxLength": 25, "type": "string", "nullable": true }, "supportedApps": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedAppModel" }, "nullable": true }, "zeroTapTermsAccepted": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "phoneNumber": { "maxLength": 20, "type": "string", "nullable": true }, "url": { "maxLength": 2000, "type": "string", "nullable": true }, "variable": { "allOf": [ { "$ref": "#/components/schemas/CreateTemplateButtonVariableModel" } ], "nullable": true } }, "additionalProperties": false }, "CreateTemplateButtonVariableModel": { "title": "CreateTemplateButtonVariableModel", "required": [ "example", "name" ], "type": "object", "properties": { "name": { "maxLength": 1024, "minLength": 1, "type": "string" }, "example": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CreateTemplateCarouselModel": { "title": "CreateTemplateCarouselModel", "required": [ "body", "buttons", "headerType", "mediaId" ], "type": "object", "properties": { "headerType": { "allOf": [ { "$ref": "#/components/schemas/TemplateCarouselType" } ] }, "mediaId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "body": { "maxLength": 1024, "minLength": 0, "type": "string" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/CreateTemplateButtonModel" } } }, "additionalProperties": false }, "CreateTemplateMessageModel": { "title": "CreateTemplateMessageModel", "required": [ "chatId", "organizationId", "templateId" ], "type": "object", "properties": { "templateId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "chatId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "params": { "maxLength": 1024, "minLength": 1, "type": "array", "items": { "type": "string" } }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "skipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false }, "bulkSession": { "type": "string", "description": "Used to group messages by a bulk send session", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "fileId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "carousel": { "type": "string", "nullable": true }, "postbackTexts": { "type": "string", "description": "JSON string representing the list of postback texts associated with quick reply buttons.", "nullable": true } }, "additionalProperties": false }, "CreateTemplateMessageOptionModel": { "title": "CreateTemplateMessageOptionModel", "allOf": [ { "$ref": "#/components/schemas/GenericOptionModel" }, { "required": [ "buttonText" ], "type": "object", "properties": { "buttonText": { "maxLength": 512, "minLength": 1, "type": "string" } }, "additionalProperties": false } ] }, "CreateTemplateMessageSimplifiedModel": { "title": "CreateTemplateMessageSimplifiedModel", "required": [ "fromPhone", "organizationId", "templateId", "toPhone" ], "type": "object", "properties": { "toPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "fromPhone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "example": "+5511987654321" }, "templateId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "params": { "maxLength": 1024, "minLength": 1, "type": "array", "items": { "type": "string" } }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "skipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false }, "bulkSession": { "type": "string", "description": "Used to group messages by a bulk send session", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "file": { "type": "string", "description": "Prefer to use FileId instead", "format": "binary", "nullable": true }, "fileId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "contactName": { "type": "string", "description": "An optional name to create the contact with if it does not exist. Will be ignored if the contact already exists", "nullable": true }, "carousel": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateTemplateMessageStepModel": { "title": "CreateTemplateMessageStepModel", "allOf": [ { "$ref": "#/components/schemas/CreateInteractiveStepModel" }, { "required": [ "options", "templateId" ], "type": "object", "properties": { "templateId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "organizationFileId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "params": { "type": "array", "items": { "type": "string" } }, "options": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CreateTemplateMessageOptionModel" } }, "noWaitResponse": { "type": "boolean" }, "carousel": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateMessageStepCarouselModel" } } }, "additionalProperties": false } ] }, "CreateTemplateModel": { "title": "CreateTemplateModel", "required": [ "channelId", "content", "label", "organizationId", "templateType" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "channelId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "label": { "maxLength": 40, "minLength": 0, "type": "string" }, "category": { "type": "string", "nullable": true }, "templateType": { "allOf": [ { "$ref": "#/components/schemas/TemplateType" } ] }, "header": { "allOf": [ { "$ref": "#/components/schemas/TemplateHeaderCreateModel" } ], "description": "Template's header. Only applicable when template type is text.", "nullable": true }, "content": { "maxLength": 1024, "minLength": 0, "type": "string" }, "footer": { "maxLength": 60, "type": "string", "nullable": true }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateExampleCreateModel" } }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/CreateTemplateButtonModel" }, "nullable": true }, "mediaId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "carousel": { "type": "array", "items": { "$ref": "#/components/schemas/CreateTemplateCarouselModel" }, "nullable": true }, "addSecurityRecommendation": { "type": "boolean" }, "codeExpirationMinutes": { "type": "integer", "format": "int32", "nullable": true }, "messageValiditySeconds": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CreateTemplateOptionModel": { "title": "CreateTemplateOptionModel", "allOf": [ { "$ref": "#/components/schemas/GenericOptionModel" }, { "required": [ "buttonParams" ], "type": "object", "properties": { "buttonParams": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "CreateTextCustomFieldDefinitionModel": { "title": "CreateTextCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CreateCustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateTimeOfDayStepModel": { "title": "CreateTimeOfDayStepModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "ranges", "timeZone" ], "type": "object", "properties": { "ranges": { "minItems": 2, "type": "array", "items": { "$ref": "#/components/schemas/StepTimeOfDayRangeModel" } }, "timeZone": { "type": "string", "description": "IANA timezone code", "format": "time-zone-id", "example": "America/Sao_Paulo" } }, "additionalProperties": false } ] }, "CreateVariableModel": { "title": "CreateVariableModel", "required": [ "_t", "name", "organizationId" ], "type": "object", "properties": { "_t": { "type": "string" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "name": { "minLength": 1, "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateVariableModel": "#/components/schemas/CreateVariableModel", "CreatePlainTextVariableModel": "#/components/schemas/CreatePlainTextVariableModel", "CreateEncryptedVariableModel": "#/components/schemas/CreateEncryptedVariableModel" } } }, "CreateWabaChannelModel": { "title": "CreateWabaChannelModel", "required": [ "businessType", "channelDisplayName", "organizationId", "wabaStatus" ], "type": "object", "properties": { "channelDisplayName": { "minLength": 1, "type": "string" }, "phoneNumber": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "nullable": true, "example": "+5511987654321" }, "about": { "type": "string", "nullable": true }, "pictureDataUrl": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "businessWebsites": { "type": "array", "items": { "type": "string" }, "nullable": true }, "address": { "oneOf": [ { "$ref": "#/components/schemas/EditAddressModel" }, { "$ref": "#/components/schemas/RequiredEditAddressModel" }, { "$ref": "#/components/schemas/CountryRequiredEditAddressModel" } ], "nullable": true }, "businessType": { "allOf": [ { "$ref": "#/components/schemas/BusinessType" } ] }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "wabaStatus": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberWabaStatus" } ] }, "defaultSectorId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "CreateWaitingActionModel": { "title": "CreateWaitingActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "interval", "nextStepId" ], "type": "object", "properties": { "interval": { "oneOf": [ { "$ref": "#/components/schemas/WaitingActionIntervalBaseModel" }, { "$ref": "#/components/schemas/WaitingActionFixedIntervalModel" }, { "$ref": "#/components/schemas/WaitingActionVariableIntervalModel" } ] }, "nextStepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "contactResponseStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "CreateWebhookActionModel": { "title": "CreateWebhookActionModel", "allOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "required": [ "_t", "uri" ], "type": "object", "properties": { "_t": { "type": "string" }, "uri": { "minLength": 1, "type": "string" }, "method": { "allOf": [ { "$ref": "#/components/schemas/WebhookMethod" } ] }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/FlowchartHeaderModel" }, "nullable": true }, "responseMessageMapper": { "type": "array", "items": { "$ref": "#/components/schemas/FlowchartResponseModel" }, "nullable": true }, "requestContent": { "type": "string", "nullable": true }, "onSuccess": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CreateWebhookActionModel": "#/components/schemas/CreateWebhookActionModel", "CreatePipedriveActionModel": "#/components/schemas/CreatePipedriveActionModel", "CreateAsaasActionModel": "#/components/schemas/CreateAsaasActionModel" } } } ] }, "CreditConversationModel": { "title": "CreditConversationModel", "type": "object", "properties": { "billable": { "type": "boolean" }, "deductedCredits": { "type": "integer", "format": "int64", "nullable": true }, "billingType": { "allOf": [ { "$ref": "#/components/schemas/BillingEventType" } ], "nullable": true }, "templateType": { "type": "string", "nullable": true }, "eventAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "isAIAudio": { "type": "boolean", "nullable": true }, "botLLM": { "allOf": [ { "$ref": "#/components/schemas/AiLLMs" } ], "nullable": true } }, "additionalProperties": false }, "CreditModel": { "title": "CreditModel", "type": "object", "properties": { "remainingCredits": { "type": "integer", "format": "int64", "readOnly": true }, "organization": { "allOf": [ { "$ref": "#/components/schemas/CreditOrganizationModel" } ] }, "packages": { "type": "array", "items": { "$ref": "#/components/schemas/CreditPackageModel" } } }, "additionalProperties": false }, "CreditOrganizationModel": { "title": "CreditOrganizationModel", "type": "object", "properties": { "consumed": { "type": "integer", "format": "int64" }, "exceeding": { "type": "integer", "format": "int64" }, "creditsValues": { "type": "array", "items": { "$ref": "#/components/schemas/CreditsValuesModel" }, "nullable": true } }, "additionalProperties": false }, "CreditPackageModel": { "title": "CreditPackageModel", "allOf": [ { "$ref": "#/components/schemas/SoftDeleteModelBase" }, { "required": [ "billingId" ], "type": "object", "properties": { "billingId": { "type": "string" }, "initiationDateUTC": { "type": "string", "format": "date-time", "nullable": true }, "expirationDateUTC": { "type": "string", "format": "date-time" }, "total": { "type": "integer", "format": "int64" }, "consumed": { "type": "integer", "format": "int64" }, "type": { "allOf": [ { "$ref": "#/components/schemas/CreditPackageType" } ] }, "reason": { "type": "string", "nullable": true }, "givenBy": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "CreditPackageType": { "title": "CreditPackageType", "enum": [ "Single", "Recurrent", "Bonus" ], "type": "string" }, "CreditsType": { "title": "CreditsType", "enum": [ "Marketing", "Utility", "Authentication", "AI" ], "type": "string" }, "CreditsValuesModel": { "title": "CreditsValuesModel", "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/CreditsType" } ] }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CrudPermission": { "title": "CrudPermission", "enum": [ "Create", "Edit", "Delete" ], "type": "string" }, "CurrencyCustomFieldDefinitionModel": { "title": "CurrencyCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "required": [ "currency" ], "type": "object", "properties": { "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyEnum" } ] }, "minRange": { "type": "number", "format": "decimal", "nullable": true }, "maxRange": { "type": "number", "format": "decimal", "nullable": true }, "scale": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "CurrencyEnum": { "title": "CurrencyEnum", "enum": [ "BRL", "USD", "ARS", "PYG" ], "type": "string" }, "CustomFieldAggregationModel": { "title": "CustomFieldAggregationModel", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "contactCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CustomFieldAggregationModel": "#/components/schemas/CustomFieldAggregationModel", "DecimalCustomFieldAggregationModel": "#/components/schemas/DecimalCustomFieldAggregationModel", "NumberCustomFieldAggregationModel": "#/components/schemas/NumberCustomFieldAggregationModel", "DateCustomFieldAggregationModel": "#/components/schemas/DateCustomFieldAggregationModel" } } }, "CustomFieldDefinitionModel": { "title": "CustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "name" ], "type": "object", "properties": { "_t": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "CustomFieldDefinitionModel": "#/components/schemas/CustomFieldDefinitionModel", "CurrencyCustomFieldDefinitionModel": "#/components/schemas/CurrencyCustomFieldDefinitionModel", "TextCustomFieldDefinitionModel": "#/components/schemas/TextCustomFieldDefinitionModel", "LogicCustomFieldDefinitionModel": "#/components/schemas/LogicCustomFieldDefinitionModel", "NumberCustomFieldDefinitionModel": "#/components/schemas/NumberCustomFieldDefinitionModel", "LinkCustomFieldDefinitionModel": "#/components/schemas/LinkCustomFieldDefinitionModel", "MemberCustomFieldDefinitionModel": "#/components/schemas/MemberCustomFieldDefinitionModel", "CNPJCustomFieldDefinitionModel": "#/components/schemas/CNPJCustomFieldDefinitionModel", "CPFCustomFieldDefinitionModel": "#/components/schemas/CPFCustomFieldDefinitionModel", "DateCustomFieldDefinitionModel": "#/components/schemas/DateCustomFieldDefinitionModel", "DecimalCustomFieldDefinitionModel": "#/components/schemas/DecimalCustomFieldDefinitionModel", "ListStringCustomFieldDefinitionModel": "#/components/schemas/ListStringCustomFieldDefinitionModel" } } } ] }, "DataConditionalModel": { "title": "DataConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "value": { "type": "string" }, "compareValue": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "DateCustomFieldAggregationModel": { "title": "DateCustomFieldAggregationModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldAggregationModel" }, { "type": "object", "properties": { "value": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false } ] }, "DateCustomFieldDefinitionModel": { "title": "DateCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "DateFlowchartVariable": { "title": "DateFlowchartVariable", "allOf": [ { "$ref": "#/components/schemas/FlowchartVariable" }, { "type": "object", "properties": { "minDate": { "type": "string", "format": "date-time" }, "maxDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false } ] }, "DateFlowchartVariableModel": { "title": "DateFlowchartVariableModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartVariableModel" }, { "type": "object", "properties": { "minDate": { "type": "string", "format": "date-time" }, "maxDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false } ] }, "DayOfTheWeekStepModel": { "title": "DayOfTheWeekStepModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "type": "object", "properties": { "stepsForDaysOfTheWeek": { "type": "array", "items": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "timeZone": { "type": "string", "description": "IANA timezone code", "format": "time-zone-id", "example": "America/Sao_Paulo" } }, "additionalProperties": false } ] }, "DaySchedule": { "title": "DaySchedule", "type": "object", "properties": { "name": { "type": "string" }, "isChecked": { "type": "boolean" }, "startTime1": { "type": "string", "format": "time", "nullable": true }, "endTime1": { "type": "string", "format": "time", "nullable": true }, "startTime2": { "type": "string", "format": "time", "nullable": true }, "endTime2": { "type": "string", "format": "time", "nullable": true } }, "additionalProperties": false }, "DecimalCustomFieldAggregationModel": { "title": "DecimalCustomFieldAggregationModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldAggregationModel" }, { "type": "object", "properties": { "value": { "type": "number", "format": "decimal", "nullable": true } }, "additionalProperties": false } ] }, "DecimalCustomFieldDefinitionModel": { "title": "DecimalCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "properties": { "minRange": { "type": "number", "format": "decimal", "nullable": true }, "maxRange": { "type": "number", "format": "decimal", "nullable": true }, "scale": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "DeleteContactChatAction": { "title": "DeleteContactChatAction", "enum": [ "Close", "Delete" ], "type": "string" }, "EditAddressModel": { "title": "EditAddressModel", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "EditAddressModel": "#/components/schemas/EditAddressModel", "RequiredEditAddressModel": "#/components/schemas/RequiredEditAddressModel", "CountryRequiredEditAddressModel": "#/components/schemas/CountryRequiredEditAddressModel" } } }, "EditBotBase": { "title": "EditBotBase", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "channelIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "description": "A list of all the channels this bot will act upon", "nullable": true }, "trigger": { "allOf": [ { "$ref": "#/components/schemas/BotTrigger" } ] }, "title": { "type": "string", "description": "The title of this bot, for internal reference only", "nullable": true }, "order": { "type": "number", "description": "The order this bot should be put alongside others when executing", "format": "float", "nullable": true }, "final": { "type": "boolean", "description": "When true, will prevent the execution of further bots on the channel if this bot decides it should execute", "nullable": true }, "active": { "type": "boolean" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "description": "The list of group IDs for this bot.", "nullable": true }, "snapshotTitle": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "EditBotBase": "#/components/schemas/EditBotBase", "EditFlowchartBotModel": "#/components/schemas/EditFlowchartBotModel" } } }, "EditContactCNPJCustomFieldModel": { "title": "EditContactCNPJCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 14, "minLength": 14, "type": "string" } }, "additionalProperties": false } ] }, "EditContactCPFCustomFieldModel": { "title": "EditContactCPFCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 11, "minLength": 11, "type": "string" } }, "additionalProperties": false } ] }, "EditContactCurrencyCustomFieldModel": { "title": "EditContactCurrencyCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maximum": 9.223372036854776E+18, "minimum": -9.223372036854776E+18, "type": "number", "format": "decimal" } }, "additionalProperties": false } ] }, "EditContactCustomFieldModel": { "title": "EditContactCustomFieldModel", "required": [ "_t", "organizationId" ], "type": "object", "properties": { "_t": { "type": "string" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "EditContactCustomFieldModel": "#/components/schemas/EditContactCustomFieldModel", "EditContactCurrencyCustomFieldModel": "#/components/schemas/EditContactCurrencyCustomFieldModel", "EditContactTextCustomFieldModel": "#/components/schemas/EditContactTextCustomFieldModel", "EditContactLinkCustomFieldModel": "#/components/schemas/EditContactLinkCustomFieldModel", "EditContactLogicCustomFieldModel": "#/components/schemas/EditContactLogicCustomFieldModel", "EditContactNumberCustomFieldModel": "#/components/schemas/EditContactNumberCustomFieldModel", "EditContactCNPJCustomFieldModel": "#/components/schemas/EditContactCNPJCustomFieldModel", "EditContactCPFCustomFieldModel": "#/components/schemas/EditContactCPFCustomFieldModel", "EditContactDateCustomFieldModel": "#/components/schemas/EditContactDateCustomFieldModel", "EditContactDecimalCustomFieldModel": "#/components/schemas/EditContactDecimalCustomFieldModel", "EditContactListStringCustomFieldModel": "#/components/schemas/EditContactListStringCustomFieldModel" } } }, "EditContactDateCustomFieldModel": { "title": "EditContactDateCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } }, "additionalProperties": false } ] }, "EditContactDecimalCustomFieldModel": { "title": "EditContactDecimalCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "decimal" } }, "additionalProperties": false } ] }, "EditContactLinkCustomFieldModel": { "title": "EditContactLinkCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 1000, "minLength": 0, "type": "string" } }, "additionalProperties": false } ] }, "EditContactListStringCustomFieldModel": { "title": "EditContactListStringCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "EditContactLogicCustomFieldModel": { "title": "EditContactLogicCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "boolean" } }, "additionalProperties": false } ] }, "EditContactNumberCustomFieldModel": { "title": "EditContactNumberCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maximum": 9.223372036854776E+18, "minimum": -9.223372036854776E+18, "type": "integer", "format": "int64" } }, "additionalProperties": false } ] }, "EditContactTextCustomFieldModel": { "title": "EditContactTextCustomFieldModel", "allOf": [ { "$ref": "#/components/schemas/EditContactCustomFieldModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 2000, "minLength": 0, "type": "string" } }, "additionalProperties": false } ] }, "EditCustomFieldDefinitionModel": { "title": "EditCustomFieldDefinitionModel", "required": [ "name", "organizationId" ], "type": "object", "properties": { "name": { "maxLength": 160, "minLength": 0, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "description": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "EditFlowchartBotModel": { "title": "EditFlowchartBotModel", "allOf": [ { "$ref": "#/components/schemas/EditBotBase" }, { "required": [ "steps" ], "type": "object", "properties": { "steps": { "minItems": 1, "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateFlowchartBotStepModel" }, { "$ref": "#/components/schemas/CreateTemplateMessageStepModel" }, { "$ref": "#/components/schemas/CreatePipedriveActionModel" }, { "$ref": "#/components/schemas/CreateAsaasActionModel" }, { "$ref": "#/components/schemas/CreateWebhookActionModel" }, { "$ref": "#/components/schemas/CreateOneShotCronActionModel" }, { "$ref": "#/components/schemas/CreateWaitingActionModel" }, { "$ref": "#/components/schemas/CreateTimeOfDayStepModel" }, { "$ref": "#/components/schemas/CreateTagActionModel" }, { "$ref": "#/components/schemas/CreateStartManualEntryActionModel" }, { "$ref": "#/components/schemas/CreateFlowchartActionModel" }, { "$ref": "#/components/schemas/CreateFlowchartBotEventModel" }, { "$ref": "#/components/schemas/CreateInteractiveStepModel" }, { "$ref": "#/components/schemas/CreateSetWaitingStateActionModel" }, { "$ref": "#/components/schemas/CreateSetInactivityActionModel" }, { "$ref": "#/components/schemas/CreateSetWaitingFlowActionModel" }, { "$ref": "#/components/schemas/CreateSetCustomFieldActionModel" }, { "$ref": "#/components/schemas/CreateChatVisibilityActionModel" }, { "$ref": "#/components/schemas/CreateSendMessageActionModel" }, { "$ref": "#/components/schemas/CreateSectorTransferActionModel" }, { "$ref": "#/components/schemas/CreateRegexStepModel" }, { "$ref": "#/components/schemas/CreateFeedbackRatingStepModel" }, { "$ref": "#/components/schemas/CreateScoreRatingStepModel" }, { "$ref": "#/components/schemas/CreateOptionsStepModel" }, { "$ref": "#/components/schemas/CreateNotifyMemberActionModel" }, { "$ref": "#/components/schemas/CreateMemberTransferActionModel" }, { "$ref": "#/components/schemas/CreateFlowchartBotManualStartedEventModel" }, { "$ref": "#/components/schemas/CreateDayOfTheWeekStepModel" }, { "$ref": "#/components/schemas/CreateConditionalActionModel" }, { "$ref": "#/components/schemas/CreateCommentBlockModel" }, { "$ref": "#/components/schemas/CreateCloseChatActionModel" }, { "$ref": "#/components/schemas/CreateFlowchartBotChatStartedEventModel" }, { "$ref": "#/components/schemas/CreateChangeChatPrivateStateActionModel" } ] } } }, "additionalProperties": false } ] }, "EditMessageModel": { "title": "EditMessageModel", "required": [ "newMessage" ], "type": "object", "properties": { "newMessage": { "maxLength": 2000, "minLength": 1, "type": "string", "description": "The new content for the message" } }, "additionalProperties": false }, "EditVariableModel": { "title": "EditVariableModel", "required": [ "name", "organizationId", "value" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "name": { "minLength": 1, "type": "string", "nullable": true }, "value": { "maxLength": 500, "minLength": 1, "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmojiUsageOption": { "title": "EmojiUsageOption", "enum": [ "None", "Discreet", "Natural", "Expressive" ], "type": "string" }, "EncryptedVariableModel": { "title": "EncryptedVariableModel", "allOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "type": "object", "additionalProperties": false } ] }, "EventType": { "title": "EventType", "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "details": { "type": "string", "nullable": true }, "descriptionTemplate": { "type": "string", "nullable": true }, "searchText": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32" }, "durationUnit": { "type": "string" }, "aiVariables": { "type": "array", "items": { "$ref": "#/components/schemas/AICapturedVariable" } }, "defineAvailableHours": { "type": "boolean" }, "daysOfWeek": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DaySchedule" } } }, "additionalProperties": false }, "EventWebhookType": { "title": "EventWebhookType", "enum": [ "Message", "MemberTransfer", "ChatClosed", "ChatSectorChanged", "ChatPrivateStatusChanged", "MessageFileUploaded", "ChatTagChanged", "NewChat" ], "type": "string" }, "ExternalApiMcpToolModel": { "title": "ExternalApiMcpToolModel", "allOf": [ { "$ref": "#/components/schemas/AiMcpToolModel" }, { "type": "object", "properties": { "enableCaching": { "type": "boolean" }, "timeoutSeconds": { "type": "integer", "format": "int32" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/ApiEndpointModel" } }, "details": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ExternalChannelBaseModel": { "title": "ExternalChannelBaseModel", "allOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ExternalChannelBaseModel": "#/components/schemas/ExternalChannelBaseModel", "PhoneNumberChannelBaseModel": "#/components/schemas/PhoneNumberChannelBaseModel", "WhatsappChannelBaseModel": "#/components/schemas/WhatsappChannelBaseModel", "BrokerWhatsappChannelModel": "#/components/schemas/BrokerWhatsappChannelModel", "GupshupWhatsappChannelModel": "#/components/schemas/GupshupWhatsappChannelModel", "CloudAPIWhatsappChannelModel": "#/components/schemas/CloudAPIWhatsappChannelModel", "UsernameChannelBaseModel": "#/components/schemas/UsernameChannelBaseModel", "InstagramChannelBaseModel": "#/components/schemas/InstagramChannelBaseModel", "GupshupInstagramChannelModel": "#/components/schemas/GupshupInstagramChannelModel", "WebsiteWidgetChannelModel": "#/components/schemas/WebsiteWidgetChannelModel" } } } ] }, "FeedbackRatingStepModel": { "title": "FeedbackRatingStepModel", "allOf": [ { "$ref": "#/components/schemas/InteractiveStepModel" }, { "required": [ "nextStepId", "repository", "text" ], "type": "object", "properties": { "text": { "type": "string" }, "repository": { "type": "string" }, "nextStepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "FieldFilterOfObjectId": { "title": "FieldFilterOfObjectId", "type": "object", "properties": { "rule": { "allOf": [ { "$ref": "#/components/schemas/FilterRules" } ] }, "values": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "FileTypes": { "title": "FileTypes", "enum": [ "Text", "Image", "Video", "Audio", "File" ], "type": "string" }, "FileVisibility": { "title": "FileVisibility", "enum": [ "All", "Member" ], "type": "string" }, "FilterRules": { "title": "FilterRules", "enum": [ "Any", "None", "ContainsAny", "NoneOrContainsAny", "NotNullNorEmpty", "ContainsAll", "Excludes" ], "type": "string" }, "FilterTypes": { "title": "FilterTypes", "enum": [ "Open", "Waiting", "Closed" ], "type": "string" }, "FirstChatInChannelConditionalModel": { "title": "FirstChatInChannelConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "isFirstChat": { "type": "boolean" } }, "additionalProperties": false } ] }, "FlowchartActionModel": { "title": "FlowchartActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "FlowchartActionModel": "#/components/schemas/FlowchartActionModel", "TagActionModel": "#/components/schemas/TagActionModel", "SetWaitingStateActionModel": "#/components/schemas/SetWaitingStateActionModel", "SetInactivityActionModel": "#/components/schemas/SetInactivityActionModel", "SetWaitingFlowActionModel": "#/components/schemas/SetWaitingFlowActionModel", "SetChatVisibilityActionModel": "#/components/schemas/SetChatVisibilityActionModel", "SendMessageActionModel": "#/components/schemas/SendMessageActionModel", "ChangeChatPrivateStateActionModel": "#/components/schemas/ChangeChatPrivateStateActionModel" } } } ] }, "FlowchartBotChatStartedEventModel": { "title": "FlowchartBotChatStartedEventModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotEventModel" }, { "type": "object", "additionalProperties": false } ] }, "FlowchartBotEventModel": { "title": "FlowchartBotEventModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "required": [ "_t", "nextStepId" ], "type": "object", "properties": { "_t": { "type": "string" }, "nextStepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "FlowchartBotEventModel": "#/components/schemas/FlowchartBotEventModel", "FlowchartBotManualStartedEventModel": "#/components/schemas/FlowchartBotManualStartedEventModel", "FlowchartBotChatStartedEventModel": "#/components/schemas/FlowchartBotChatStartedEventModel" } } } ] }, "FlowchartBotInstanceModel": { "title": "FlowchartBotInstanceModel", "required": [ "bot", "botQuestions", "chat", "data" ], "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "bot": { "allOf": [ { "$ref": "#/components/schemas/FlowchartBotModel" } ] }, "botSnapshotId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "botId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "botTitle": { "type": "string" }, "botQuestions": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BotQuestionModel" }, { "$ref": "#/components/schemas/ObjectiveBotQuestionModel" }, { "$ref": "#/components/schemas/SubjectiveQuestionModel" } ] } }, "data": { "type": "object", "additionalProperties": { } }, "chat": { "allOf": [ { "$ref": "#/components/schemas/ChatIdReferenceModel" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/BotStatus" } ] }, "createdAtUTC": { "type": "string", "format": "date-time" }, "routeTracking": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "FlowchartBotManualStartedEventModel": { "title": "FlowchartBotManualStartedEventModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotEventModel" }, { "required": [ "triggerName", "variables" ], "type": "object", "properties": { "hidden": { "type": "boolean" }, "triggerName": { "type": "string" }, "variables": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/FlowchartVariableModel" }, { "$ref": "#/components/schemas/TextFlowchartVariableModel" }, { "$ref": "#/components/schemas/NumberFlowchartVariableModel" }, { "$ref": "#/components/schemas/TimeFlowchartVariableModel" }, { "$ref": "#/components/schemas/DateFlowchartVariableModel" }, { "$ref": "#/components/schemas/ListTextFlowchartVariableModel" } ] } } }, "additionalProperties": false } ] }, "FlowchartBotModel": { "title": "FlowchartBotModel", "allOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "required": [ "manualTriggers", "steps", "triggers" ], "type": "object", "properties": { "triggers": { "type": "array", "items": { "$ref": "#/components/schemas/BotEvent" } }, "manualTriggers": { "type": "array", "items": { "type": "string" } }, "steps": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "$ref": "#/components/schemas/TemplateMessageStepModel" }, { "$ref": "#/components/schemas/PipedriveActionModel" }, { "$ref": "#/components/schemas/AsaasActionModel" }, { "$ref": "#/components/schemas/WebhookActionModel" }, { "$ref": "#/components/schemas/OneShotCronActionModel" }, { "$ref": "#/components/schemas/WaitingActionModel" }, { "$ref": "#/components/schemas/TimeOfDayStepModel" }, { "$ref": "#/components/schemas/TagActionModel" }, { "$ref": "#/components/schemas/StartManualEntryActionModel" }, { "$ref": "#/components/schemas/FlowchartActionModel" }, { "$ref": "#/components/schemas/FlowchartBotEventModel" }, { "$ref": "#/components/schemas/InteractiveStepModel" }, { "$ref": "#/components/schemas/SetWaitingStateActionModel" }, { "$ref": "#/components/schemas/SetInactivityActionModel" }, { "$ref": "#/components/schemas/SetWaitingFlowActionModel" }, { "$ref": "#/components/schemas/SetCustomFieldActionModel" }, { "$ref": "#/components/schemas/SetChatVisibilityActionModel" }, { "$ref": "#/components/schemas/SendMessageActionModel" }, { "$ref": "#/components/schemas/SectorTransferActionModel" }, { "$ref": "#/components/schemas/RegexStepModel" }, { "$ref": "#/components/schemas/FeedbackRatingStepModel" }, { "$ref": "#/components/schemas/ScoreRatingStepModel" }, { "$ref": "#/components/schemas/OptionsStepModel" }, { "$ref": "#/components/schemas/NotifyMemberActionModel" }, { "$ref": "#/components/schemas/MemberTransferActionModel" }, { "$ref": "#/components/schemas/FlowchartBotManualStartedEventModel" }, { "$ref": "#/components/schemas/DayOfTheWeekStepModel" }, { "$ref": "#/components/schemas/ConditionalActionModel" }, { "$ref": "#/components/schemas/CommentBlockModel" }, { "$ref": "#/components/schemas/CloseChatActionModel" }, { "$ref": "#/components/schemas/FlowchartBotChatStartedEventModel" }, { "$ref": "#/components/schemas/ChangeChatPrivateStateActionModel" } ] } } }, "additionalProperties": false } ] }, "FlowchartBotStepModel": { "title": "FlowchartBotStepModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "position" ], "type": "object", "properties": { "_t": { "type": "string" }, "position": { "allOf": [ { "$ref": "#/components/schemas/PositionModel" } ] } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "FlowchartBotStepModel": "#/components/schemas/FlowchartBotStepModel", "TemplateMessageStepModel": "#/components/schemas/TemplateMessageStepModel", "PipedriveActionModel": "#/components/schemas/PipedriveActionModel", "AsaasActionModel": "#/components/schemas/AsaasActionModel", "WebhookActionModel": "#/components/schemas/WebhookActionModel", "OneShotCronActionModel": "#/components/schemas/OneShotCronActionModel", "WaitingActionModel": "#/components/schemas/WaitingActionModel", "TimeOfDayStepModel": "#/components/schemas/TimeOfDayStepModel", "TagActionModel": "#/components/schemas/TagActionModel", "StartManualEntryActionModel": "#/components/schemas/StartManualEntryActionModel", "FlowchartActionModel": "#/components/schemas/FlowchartActionModel", "FlowchartBotEventModel": "#/components/schemas/FlowchartBotEventModel", "InteractiveStepModel": "#/components/schemas/InteractiveStepModel", "SetWaitingStateActionModel": "#/components/schemas/SetWaitingStateActionModel", "SetInactivityActionModel": "#/components/schemas/SetInactivityActionModel", "SetWaitingFlowActionModel": "#/components/schemas/SetWaitingFlowActionModel", "SetCustomFieldActionModel": "#/components/schemas/SetCustomFieldActionModel", "SetChatVisibilityActionModel": "#/components/schemas/SetChatVisibilityActionModel", "SendMessageActionModel": "#/components/schemas/SendMessageActionModel", "SectorTransferActionModel": "#/components/schemas/SectorTransferActionModel", "RegexStepModel": "#/components/schemas/RegexStepModel", "FeedbackRatingStepModel": "#/components/schemas/FeedbackRatingStepModel", "ScoreRatingStepModel": "#/components/schemas/ScoreRatingStepModel", "OptionsStepModel": "#/components/schemas/OptionsStepModel", "NotifyMemberActionModel": "#/components/schemas/NotifyMemberActionModel", "MemberTransferActionModel": "#/components/schemas/MemberTransferActionModel", "FlowchartBotManualStartedEventModel": "#/components/schemas/FlowchartBotManualStartedEventModel", "DayOfTheWeekStepModel": "#/components/schemas/DayOfTheWeekStepModel", "ConditionalActionModel": "#/components/schemas/ConditionalActionModel", "CommentBlockModel": "#/components/schemas/CommentBlockModel", "CloseChatActionModel": "#/components/schemas/CloseChatActionModel", "FlowchartBotChatStartedEventModel": "#/components/schemas/FlowchartBotChatStartedEventModel", "ChangeChatPrivateStateActionModel": "#/components/schemas/ChangeChatPrivateStateActionModel" } } } ] }, "FlowchartHeaderModel": { "title": "FlowchartHeaderModel", "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "FlowchartManualStartStep": { "title": "FlowchartManualStartStep", "required": [ "botTitle", "triggerName" ], "type": "object", "properties": { "botId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "stepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "triggerName": { "type": "string" }, "hidden": { "type": "boolean" }, "botTitle": { "type": "string" }, "variables": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/FlowchartVariable" }, { "$ref": "#/components/schemas/TextFlowchartVariable" }, { "$ref": "#/components/schemas/NumberFlowchartVariable" }, { "$ref": "#/components/schemas/TimeFlowchartVariable" }, { "$ref": "#/components/schemas/DateFlowchartVariable" }, { "$ref": "#/components/schemas/ListTextFlowchartVariable" } ] } }, "parallel": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "FlowchartResponseModel": { "title": "FlowchartResponseModel", "required": [ "from" ], "type": "object", "properties": { "from": { "type": "string", "description": "Response json field path" }, "to": { "type": "string", "description": "Destination BotContext var, to store json field value, when type is BotContext", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/FlowchartResponseType" } ], "nullable": true }, "contactFieldDefinition": { "allOf": [ { "$ref": "#/components/schemas/ContactFieldDefinition" } ], "description": "Destination Contact default field when type is Contact", "nullable": true }, "customFieldDefinitionId": { "type": "string", "description": "Destination Contact custonField when type is Contact", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "parseCulture": { "type": "string", "description": "The Language Code ID", "format": "culture-info-id", "nullable": true, "example": "pt-BR" } }, "additionalProperties": false }, "FlowchartResponseType": { "title": "FlowchartResponseType", "enum": [ "BotContext", "Contact" ], "type": "string" }, "FlowchartVariable": { "title": "FlowchartVariable", "required": [ "_t", "name" ], "type": "object", "properties": { "_t": { "type": "string" }, "name": { "type": "string" }, "example": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "FlowchartVariable": "#/components/schemas/FlowchartVariable", "TextFlowchartVariable": "#/components/schemas/TextFlowchartVariable", "NumberFlowchartVariable": "#/components/schemas/NumberFlowchartVariable", "TimeFlowchartVariable": "#/components/schemas/TimeFlowchartVariable", "DateFlowchartVariable": "#/components/schemas/DateFlowchartVariable", "ListTextFlowchartVariable": "#/components/schemas/ListTextFlowchartVariable" } } }, "FlowchartVariableListItem": { "title": "FlowchartVariableListItem", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FlowchartVariableListItemModel": { "title": "FlowchartVariableListItemModel", "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FlowchartVariableModel": { "title": "FlowchartVariableModel", "required": [ "_t", "name" ], "type": "object", "properties": { "_t": { "type": "string" }, "name": { "type": "string" }, "example": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "FlowchartVariableModel": "#/components/schemas/FlowchartVariableModel", "TextFlowchartVariableModel": "#/components/schemas/TextFlowchartVariableModel", "NumberFlowchartVariableModel": "#/components/schemas/NumberFlowchartVariableModel", "TimeFlowchartVariableModel": "#/components/schemas/TimeFlowchartVariableModel", "DateFlowchartVariableModel": "#/components/schemas/DateFlowchartVariableModel", "ListTextFlowchartVariableModel": "#/components/schemas/ListTextFlowchartVariableModel" } } }, "ForwardMessageModel": { "title": "ForwardMessageModel", "required": [ "chatId", "organizationId" ], "type": "object", "properties": { "chatId": { "type": "string", "description": "The chat to forward the message to", "example": "AB_12-xyzEXAMPLE" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "skipReassign": { "type": "boolean", "description": "When true, will skip the step of reassigning the conversation to the user who sent the message", "default": false } }, "additionalProperties": false }, "FriendlyErrorReasons": { "title": "FriendlyErrorReasons", "enum": [ "ProOffline", "BSPRejected", "BSPError", "BSPUnknown", "BSPUnavailable", "Unknown", "BrokerUnavailable", "BrokerUnknown", "BrokerError", "BrokerWhatsappWebIsOpening", "BrokerContainerOrSessionOffline", "BrokerQRCodeWasNotScanned", "BrokerCouldntDetermineMessageWasSent", "MaxTemplateCountReached", "ContactInactiveRequiresTemplate", "UserDoesNotExist", "FacebookSendTemplateLimitReached", "FacebookSendTemplateLimitReachedPerSpam", "CreditsEndedOrHasntEnough", "PhoneNumberIsPartOfAnExperiment", "UnsupportedAnimatedSticker", "TemplateTooNew", "CharacterPolicyViolated", "MessageUndeliverable", "MessageTypeUnsupported", "NotDeliveredToMaintainHealthyEcosystemEngagement", "TemplateDidNotMatch", "BusinessAccountLocked", "MediaUploadError", "BusinessAccountOAuthError", "TemplateSendingInterruption", "TemplateTextTooLong", "InvalidParameter" ], "type": "string" }, "FriendlyRejectReason": { "title": "FriendlyRejectReason", "enum": [ "HeaderHasForbiddenCharacters", "CannotHaveSameTextInMultipleButtons", "DirectLinksWhatsAppNotAllowedForButtons", "InternalServerError", "TypeFileNotSupported", "Scam", "InvalidFormat", "BodyCannotHaveVariablesOnStartOrEnd", "HeaderCannotBeUsedOnAuthenticationCategory", "AuthenticationCategoryMustHaveExactlyOneButton", "ButtonHasForbiddenCharacters", "FooterCannotHaveNewlinesOrEmojis", "TemplateNameCanOnlyHaveLowercaseLettersAndUnderscores", "UnexpectedErrorOccurred", "IncorrectCategory", "AbusiveContent", "HeaderCanOnlyHaveOneVariable", "BodyCannotHaveMoreThanTwoConsecutiveNewlines", "UnsupportedPostRequest", "AccountRestrictedCreatingTemplates", "CharacterLimitExceeded", "FailedToGetVerificationState", "AuthenticationTemplatesMustUseFixedContentBuilder", "ParametersInAuthenticationTemplatesMayNotContainURL", "AuthenticationTemplatesMayNotContainURL", "AuthenticationTemplatesMayNotContainEmojis", "UnableToPerformActionRestrictedAccount", "HeaderTypeImageIsNotSupportedForAuthenticationTemplates", "PortugueseContentAlreadyExistsForThisTemplate", "CategoryMarketingDoesntMatchTheOneAlreadyAssociatedUtility", "ButtonExampleProvidedIsInvalid", "ErrorValidatingAccessToken", "BodyCannotHaveMoreThanTwoConsecutiveNewlinesOrOnlyHaveParameters", "ParamComponentsNotAValidURI", "ParamComponentsNotAnArray", "ButtonHasInvalidURL", "BodyComponentIsMissing" ], "type": "string" }, "FullAITalkAgentModel": { "title": "FullAITalkAgentModel", "allOf": [ { "$ref": "#/components/schemas/SimpleAITalkAgentModel" }, { "type": "object", "properties": { "communicationStyle": { "allOf": [ { "$ref": "#/components/schemas/CommunicationStyles" } ] }, "organizationName": { "type": "string", "nullable": true }, "organizationWebsite": { "type": "string", "nullable": true }, "generalPrompt": { "type": "string", "nullable": true }, "autoGeneratedPrompt": { "type": "string", "nullable": true }, "selectedFunctionKey": { "type": "string", "nullable": true }, "organizationIndustry": { "type": "string", "nullable": true }, "organizationPrimaryProduct": { "type": "string", "nullable": true }, "intents": { "type": "array", "items": { "$ref": "#/components/schemas/AiIntentModel" } }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/AiStageModel" } }, "maxResponses": { "type": "integer", "format": "int32" }, "maxCharacterByResponses": { "type": "integer", "format": "int32" }, "replyAfterTransfer": { "type": "boolean" }, "inactivityWindowToReply": { "type": "integer", "format": "int32" }, "replyInAudio": { "allOf": [ { "$ref": "#/components/schemas/ReplyInAudio" } ] }, "agentIdentityStyle": { "allOf": [ { "$ref": "#/components/schemas/AgentIdentityOption" } ] }, "conversationPace": { "allOf": [ { "$ref": "#/components/schemas/ConversationPaceOption" } ] }, "communicationTone": { "allOf": [ { "$ref": "#/components/schemas/CommunicationToneOption" } ] }, "emojiUsage": { "allOf": [ { "$ref": "#/components/schemas/EmojiUsageOption" } ] }, "voice": { "allOf": [ { "$ref": "#/components/schemas/AgentVoiceModel" } ], "nullable": true }, "workloads": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentWorkloadModel" } }, "aiBotLocale": { "allOf": [ { "$ref": "#/components/schemas/AILocale" } ] }, "llmTemperature": { "type": "number", "format": "float" }, "allowedCustomFields": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "nullable": true }, "invalidMessageIntent": { "allOf": [ { "$ref": "#/components/schemas/AiIntentModel" } ], "nullable": true }, "maxResponsesIntent": { "allOf": [ { "$ref": "#/components/schemas/AiIntentModel" } ], "nullable": true }, "mcpTools": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AiMcpToolModel" }, { "$ref": "#/components/schemas/GoogleCalendarMcpToolModel" }, { "$ref": "#/components/schemas/ExternalApiMcpToolModel" }, { "$ref": "#/components/schemas/GoogleSheetsMcpToolModel" } ] } }, "allowed_kb_ids": { "type": "array", "items": { "type": "string" } }, "knowledge_bases": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseModel" } } }, "additionalProperties": false } ] }, "GenericOptionModel": { "title": "GenericOptionModel", "required": [ "_t", "stepId" ], "type": "object", "properties": { "_t": { "type": "string" }, "stepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "GenericOptionModel": "#/components/schemas/GenericOptionModel", "CreateTemplateMessageOptionModel": "#/components/schemas/CreateTemplateMessageOptionModel", "CreateTemplateOptionModel": "#/components/schemas/CreateTemplateOptionModel", "CreateRegexOptionModel": "#/components/schemas/CreateRegexOptionModel", "CreateBotOptionModel": "#/components/schemas/CreateBotOptionModel" } } }, "GoogleCalendarMcpToolModel": { "title": "GoogleCalendarMcpToolModel", "allOf": [ { "$ref": "#/components/schemas/AiMcpToolModel" }, { "required": [ "availableCalendars" ], "type": "object", "properties": { "availableCalendars": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableCalendarModel" } }, "calendars": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarModel" } }, "refreshToken": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "GoogleSheetsMcpToolModel": { "title": "GoogleSheetsMcpToolModel", "allOf": [ { "$ref": "#/components/schemas/AiMcpToolModel" }, { "type": "object", "properties": { "spreadsheets": { "type": "array", "items": { "$ref": "#/components/schemas/SpreadsheetModel" } } }, "additionalProperties": false } ] }, "GreetingBotModel": { "title": "GreetingBotModel", "allOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false } ] }, "GroupModel": { "title": "GroupModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "GupshupChannelSteps": { "title": "GupshupChannelSteps", "enum": [ "GetOrCreateApp", "LinkPartner", "SetCreationOrMigration", "EnableTemplates", "SetWebhooks", "GetEmbedLink", "CheckOnline", "UpdateProfileAbout", "UpdateProfileDetails", "UpdateProfilePicture" ], "type": "string" }, "GupshupEmbedLinkModel": { "title": "GupshupEmbedLinkModel", "required": [ "expiresAtUTC", "link" ], "type": "object", "properties": { "link": { "type": "string", "format": "uri", "example": "https://example.com" }, "expiresAtUTC": { "type": "string", "format": "date-time" }, "clicked": { "type": "boolean" } }, "additionalProperties": false }, "GupshupInstagramChannelModel": { "title": "GupshupInstagramChannelModel", "allOf": [ { "$ref": "#/components/schemas/InstagramChannelBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "GupshupWhatsappChannelModel": { "title": "GupshupWhatsappChannelModel", "allOf": [ { "$ref": "#/components/schemas/WhatsappChannelBaseModel" }, { "required": [ "wabaEvents" ], "type": "object", "properties": { "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelFilter" } ], "readOnly": true, "deprecated": true }, "about": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "businessWebsites": { "type": "array", "items": { "type": "string" }, "nullable": true }, "contactEmailAddress": { "type": "string", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "contactPhoneNumber": { "type": "string", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/AddressModel" } ], "nullable": true }, "businessType": { "type": "string", "nullable": true }, "wabaEvents": { "type": "array", "items": { "$ref": "#/components/schemas/WABAEventModel" } }, "wabaState": { "allOf": [ { "$ref": "#/components/schemas/WABAState" } ] }, "host": { "type": "string", "nullable": true }, "isCoex": { "type": "boolean" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "completedSteps": { "type": "array", "items": { "$ref": "#/components/schemas/GupshupChannelSteps" } }, "embedLink": { "allOf": [ { "$ref": "#/components/schemas/GupshupEmbedLinkModel" } ], "nullable": true } }, "additionalProperties": false } ] }, "HttpValidationProblemDetails": { "title": "HttpValidationProblemDetails", "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "additionalProperties": { } } ] }, "HumanOrganizationAgentModel": { "title": "HumanOrganizationAgentModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationAgentModel" }, { "required": [ "emailAddress" ], "type": "object", "properties": { "emailAddress": { "type": "string" }, "cellphone": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "A phone number in the E.164 standard", "nullable": true, "example": "+5511987654321" }, "messageEndChat": { "type": "string", "nullable": true }, "umblerAccountId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "IdentifierReferenceBaseModel": { "title": "IdentifierReferenceBaseModel", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "IdentifierReferenceBaseModel": "#/components/schemas/IdentifierReferenceBaseModel", "SimpleTagReferenceModel": "#/components/schemas/SimpleTagReferenceModel", "TagReferenceIdModel": "#/components/schemas/TagReferenceIdModel", "TagModel": "#/components/schemas/TagModel", "ReferenceBaseModel": "#/components/schemas/ReferenceBaseModel", "ReferenceNullableNameBaseModel": "#/components/schemas/ReferenceNullableNameBaseModel", "SectorHistoryReferenceModel": "#/components/schemas/SectorHistoryReferenceModel", "SectorHistoryReferenceIdModel": "#/components/schemas/SectorHistoryReferenceIdModel", "SectorReferenceModel": "#/components/schemas/SectorReferenceModel", "SectorReferenceIdModel": "#/components/schemas/SectorReferenceIdModel", "ScheduledMessageBotReferenceModel": "#/components/schemas/ScheduledMessageBotReferenceModel", "ScheduledMessageReferenceIdModel": "#/components/schemas/ScheduledMessageReferenceIdModel", "ScheduledMessageReferenceModel": "#/components/schemas/ScheduledMessageReferenceModel", "ReportContactModel": "#/components/schemas/ReportContactModel", "ReportSectorModel": "#/components/schemas/ReportSectorModel", "ReportTagModel": "#/components/schemas/ReportTagModel", "AgentReferenceIdModel": "#/components/schemas/AgentReferenceIdModel", "AgentReferenceModel": "#/components/schemas/AgentReferenceModel", "ChatAgentReferenceModel": "#/components/schemas/ChatAgentReferenceModel", "ChatMemberReferenceModel": "#/components/schemas/ChatMemberReferenceModel", "CloserAgentReferenceModel": "#/components/schemas/CloserAgentReferenceModel", "OrganizationAgentReferenceModel": "#/components/schemas/OrganizationAgentReferenceModel", "OrganizationAIAgentReferenceModel": "#/components/schemas/OrganizationAIAgentReferenceModel", "OrganizationHumanAgentReferenceModel": "#/components/schemas/OrganizationHumanAgentReferenceModel", "QuickAnswerAgentReferenceModel": "#/components/schemas/QuickAnswerAgentReferenceModel", "SimpleAgentReferenceModel": "#/components/schemas/SimpleAgentReferenceModel", "SimpleHumanTalkAgentModel": "#/components/schemas/SimpleHumanTalkAgentModel", "SimpleTalkAgentModel": "#/components/schemas/SimpleTalkAgentModel", "UTalkUserIdReferenceModel": "#/components/schemas/UTalkUserIdReferenceModel", "OrganizationFieldReferenceModel": "#/components/schemas/OrganizationFieldReferenceModel", "OrganizationReferenceForAITalkAgentModel": "#/components/schemas/OrganizationReferenceForAITalkAgentModel", "OrganizationReferenceForHumanAgentModel": "#/components/schemas/OrganizationReferenceForHumanAgentModel", "OrganizationReferenceIdModel": "#/components/schemas/OrganizationReferenceIdModel", "OrganizationReferenceModel": "#/components/schemas/OrganizationReferenceModel", "BotShortcutModel": "#/components/schemas/BotShortcutModel", "ContactReferenceIdModel": "#/components/schemas/ContactReferenceIdModel", "MessageReferenceModel": "#/components/schemas/MessageReferenceModel", "MessageReplyReferenceModel": "#/components/schemas/MessageReplyReferenceModel", "ContactReferenceModel": "#/components/schemas/ContactReferenceModel", "ScheduledMessageContactReferenceModel": "#/components/schemas/ScheduledMessageContactReferenceModel", "ChatFilterModel": "#/components/schemas/ChatFilterModel", "ReorderChatFilterModel": "#/components/schemas/ReorderChatFilterModel", "ChatIdReferenceModel": "#/components/schemas/ChatIdReferenceModel", "ChannelReferenceIdModel": "#/components/schemas/ChannelReferenceIdModel", "ChatChannelReferenceBaseModel": "#/components/schemas/ChatChannelReferenceBaseModel", "ChatInternalChannelReferenceBaseModel": "#/components/schemas/ChatInternalChannelReferenceBaseModel", "ChatWelcomerChannelReferenceModel": "#/components/schemas/ChatWelcomerChannelReferenceModel", "ChatMembersChannelReferenceModel": "#/components/schemas/ChatMembersChannelReferenceModel", "ChatExternalChannelReferenceBaseModel": "#/components/schemas/ChatExternalChannelReferenceBaseModel", "ChatWebsiteWidgetChannelReferenceModel": "#/components/schemas/ChatWebsiteWidgetChannelReferenceModel", "ChatPhoneNumberChannelReferenceBaseModel": "#/components/schemas/ChatPhoneNumberChannelReferenceBaseModel", "ChatWhatsappChannelReferenceBaseModel": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel", "ChatBrokerWhatsappChannelReferenceModel": "#/components/schemas/ChatBrokerWhatsappChannelReferenceModel", "ChatGupshupWhatsappChannelReferenceModel": "#/components/schemas/ChatGupshupWhatsappChannelReferenceModel", "ChatCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/ChatCloudAPIWhatsappChannelReferenceModel", "ChatUsernameChannelReferenceBaseModel": "#/components/schemas/ChatUsernameChannelReferenceBaseModel", "ChatInstagramChannelReferenceBaseModel": "#/components/schemas/ChatInstagramChannelReferenceBaseModel", "ChatGupshupInstagramChannelReferenceModel": "#/components/schemas/ChatGupshupInstagramChannelReferenceModel", "OrganizationChannelReferenceBaseModel": "#/components/schemas/OrganizationChannelReferenceBaseModel", "OrganizationInternalChannelReferenceBaseModel": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel", "OrganizationWelcomerChannelReferenceModel": "#/components/schemas/OrganizationWelcomerChannelReferenceModel", "OrganizationMembersChannelReferenceModel": "#/components/schemas/OrganizationMembersChannelReferenceModel", "OrganizationExternalChannelReferenceBaseModel": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel", "OrganizationWebsiteWidgetChannelReferenceModel": "#/components/schemas/OrganizationWebsiteWidgetChannelReferenceModel", "OrganizationPhoneNumberChannelReferenceBaseModel": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel", "OrganizationWhatsappChannelReferenceBaseModel": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel", "OrganizationBrokerWhatsappChannelReferenceModel": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel", "OrganizationGupshupWhatsappChannelReferenceModel": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel", "OrganizationCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel", "OrganizationUsernameChannelReferenceBaseModel": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel", "OrganizationInstagramChannelReferenceBaseModel": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel", "OrganizationGupshupInstagramChannelReferenceModel": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel", "ScheduledMessageChannelReferenceModel": "#/components/schemas/ScheduledMessageChannelReferenceModel", "TemplateChannelReferenceModel": "#/components/schemas/TemplateChannelReferenceModel", "BulkSendSessionReferenceModel": "#/components/schemas/BulkSendSessionReferenceModel", "BotInstanceReferenceModel": "#/components/schemas/BotInstanceReferenceModel", "BulkSendBotInstanceReferenceModel": "#/components/schemas/BulkSendBotInstanceReferenceModel", "FullAITalkAgentModel": "#/components/schemas/FullAITalkAgentModel", "SimpleAITalkAgentModel": "#/components/schemas/SimpleAITalkAgentModel" } } }, "InactivityFlowBehaviorModel": { "title": "InactivityFlowBehaviorModel", "type": "object", "properties": { "behavior": { "allOf": [ { "$ref": "#/components/schemas/InactivityFlowBehaviors" } ] }, "timeout": { "type": "string", "format": "time-span", "nullable": true }, "bot": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ], "nullable": true } }, "additionalProperties": false }, "InactivityFlowBehaviors": { "title": "InactivityFlowBehaviors", "enum": [ "Disable", "CloseChat", "ExecuteBot" ], "type": "string" }, "IngestStatus": { "title": "IngestStatus", "enum": [ "AlreadyRunning", "Done", "NothingChanged", "NoKnowledgeBase" ], "type": "string" }, "InstagramChannelBaseModel": { "title": "InstagramChannelBaseModel", "allOf": [ { "$ref": "#/components/schemas/UsernameChannelBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "InstagramChannelBaseModel": "#/components/schemas/InstagramChannelBaseModel", "GupshupInstagramChannelModel": "#/components/schemas/GupshupInstagramChannelModel" } } } ] }, "InteractiveStepModel": { "title": "InteractiveStepModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "onResponseFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onTimeout": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "timeout": { "type": "string", "format": "time-span", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "InteractiveStepModel": "#/components/schemas/InteractiveStepModel", "TemplateMessageStepModel": "#/components/schemas/TemplateMessageStepModel", "RegexStepModel": "#/components/schemas/RegexStepModel", "FeedbackRatingStepModel": "#/components/schemas/FeedbackRatingStepModel", "ScoreRatingStepModel": "#/components/schemas/ScoreRatingStepModel", "OptionsStepModel": "#/components/schemas/OptionsStepModel" } } } ] }, "InternalChannelBaseModel": { "title": "InternalChannelBaseModel", "allOf": [ { "$ref": "#/components/schemas/ChannelBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "InternalChannelBaseModel": "#/components/schemas/InternalChannelBaseModel", "WelcomerChannelModel": "#/components/schemas/WelcomerChannelModel", "MembersChannelModel": "#/components/schemas/MembersChannelModel" } } } ] }, "InternalErrorBasicDetails": { "title": "InternalErrorBasicDetails", "type": "object", "properties": { "incidentId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "KnowledgeBaseAgentModel": { "title": "KnowledgeBaseAgentModel", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "KnowledgeBaseModel": { "title": "KnowledgeBaseModel", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "status": { "allOf": [ { "$ref": "#/components/schemas/KnowledgeBaseStatuses" } ] } }, "additionalProperties": false }, "KnowledgeBaseStatuses": { "title": "KnowledgeBaseStatuses", "enum": [ "Synced", "OutOfSync", "NeverSynced", "Syncing" ], "type": "string" }, "LastMessage": { "title": "LastMessage", "enum": [ "Contact", "Member", "All" ], "type": "string" }, "LatestEditModel": { "title": "LatestEditModel", "type": "object", "properties": { "content": { "type": "string", "nullable": true }, "senderAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "msgKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LinkCustomFieldDefinitionModel": { "title": "LinkCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "ListStringCustomFieldDefinitionModel": { "title": "ListStringCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "ListTextFlowchartVariable": { "title": "ListTextFlowchartVariable", "allOf": [ { "$ref": "#/components/schemas/FlowchartVariable" }, { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/FlowchartVariableListItem" } } }, "additionalProperties": false } ] }, "ListTextFlowchartVariableModel": { "title": "ListTextFlowchartVariableModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartVariableModel" }, { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/FlowchartVariableListItemModel" } } }, "additionalProperties": false } ] }, "LocationModel": { "title": "LocationModel", "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LogLevel": { "title": "LogLevel", "enum": [ "Trace", "Debug", "Information", "Warning", "Error", "Critical", "None" ], "type": "string" }, "LogicCustomFieldDefinitionModel": { "title": "LogicCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "ManualStartPath": { "title": "ManualStartPath", "required": [ "botId", "triggerName" ], "type": "object", "properties": { "botId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "triggerName": { "minLength": 1, "type": "string" }, "initialData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "parallel": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "MatchStrategy": { "title": "MatchStrategy", "enum": [ "Global", "Group" ], "type": "string" }, "MemberAllowedChannelModel": { "title": "MemberAllowedChannelModel", "required": [ "channels" ], "type": "object", "properties": { "allChannelsEnable": { "type": "boolean" }, "channels": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "MemberAllowedChannelSessionModel": { "title": "MemberAllowedChannelSessionModel", "required": [ "channelsSession" ], "type": "object", "properties": { "allChannelsSessionEnable": { "type": "boolean" }, "channelsSession": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "MemberAllowedContactsBoardModel": { "title": "MemberAllowedContactsBoardModel", "required": [ "contactsBoards" ], "type": "object", "properties": { "allContactsBoardsEnable": { "type": "boolean" }, "contactsBoards": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "MemberAllowedSectorModel": { "title": "MemberAllowedSectorModel", "required": [ "sectors" ], "type": "object", "properties": { "allSectorsEnable": { "type": "boolean" }, "sectors": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false }, "MemberConditionalModel": { "title": "MemberConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "MemberCustomFieldDefinitionModel": { "title": "MemberCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "MemberGroupContactsProperty": { "title": "MemberGroupContactsProperty", "enum": [ "Name" ], "type": "string" }, "MemberTransferActionModel": { "title": "MemberTransferActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "required": [ "options" ], "type": "object", "properties": { "target": { "allOf": [ { "$ref": "#/components/schemas/MemberTransferTarget" } ] }, "options": { "allOf": [ { "$ref": "#/components/schemas/MemberTransferModel" } ] }, "onlyMembersAvailable": { "type": "boolean" }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "MemberTransferModel": { "title": "MemberTransferModel", "required": [ "memberIds" ], "type": "object", "properties": { "memberIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/MemberTransferStrategy" } ] } }, "additionalProperties": false }, "MemberTransferStrategy": { "title": "MemberTransferStrategy", "enum": [ "Direct", "RoundRobin", "LoadBalancing", "LastMemberFromSameChatChannel", "NoOne" ], "type": "string" }, "MemberTransferTarget": { "title": "MemberTransferTarget", "enum": [ "All", "AIAgent" ], "type": "string" }, "MembersChannelModel": { "title": "MembersChannelModel", "allOf": [ { "$ref": "#/components/schemas/InternalChannelBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "MentionType": { "title": "MentionType", "enum": [ "Member", "Contact", "Unknown" ], "type": "string" }, "MessageBillableCreditType": { "title": "MessageBillableCreditType", "enum": [ "Template", "AI" ], "type": "string" }, "MessageBillableModel": { "title": "MessageBillableModel", "required": [ "creditType" ], "type": "object", "properties": { "billable": { "type": "boolean" }, "singlePackageId": { "type": "string", "nullable": true }, "deductedCredits": { "type": "integer", "format": "int64", "nullable": true }, "templateType": { "type": "string", "nullable": true }, "billingConversationWindowId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "creditType": { "allOf": [ { "$ref": "#/components/schemas/MessageBillableCreditType" } ] }, "eventAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "isAIAudio": { "type": "boolean" }, "botLLM": { "allOf": [ { "$ref": "#/components/schemas/AiLLMs" } ], "nullable": true } }, "additionalProperties": false }, "MessageButtonModel": { "title": "MessageButtonModel", "allOf": [ { "$ref": "#/components/schemas/TemplateButtonModel" }, { "type": "object", "properties": { "selected": { "type": "boolean" }, "copyCode": { "type": "string", "nullable": true }, "postbackText": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "MessageCarouselModel": { "title": "MessageCarouselModel", "required": [ "body", "buttons", "fileUrl" ], "type": "object", "properties": { "headerType": { "allOf": [ { "$ref": "#/components/schemas/TemplateCarouselType" } ] }, "body": { "type": "string" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/MessageButtonModel" } }, "fileUrl": { "type": "string" } }, "additionalProperties": false }, "MessageFileModel": { "title": "MessageFileModel", "type": "object", "properties": { "url": { "type": "string", "description": "A URL to the uploaded file", "format": "uri", "nullable": true, "example": "https://example.com" }, "contentType": { "type": "string", "description": "The original content-type of the file", "nullable": true }, "originalName": { "type": "string", "description": "The original name of the file", "nullable": true }, "originalSizeBytes": { "type": "integer", "description": "The original size of the file, expressed in bytes", "format": "int64", "nullable": true }, "data": { "type": "string", "description": "Binary data of the file, when applicable", "format": "byte", "nullable": true }, "failDownload": { "type": "boolean" }, "caption": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MessageMentionModel": { "title": "MessageMentionModel", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the mentioned entity (OrganizationMember or Contact).\nNull if the mentioned user is not in the system.", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "source": { "allOf": [ { "$ref": "#/components/schemas/MessageSources" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/MentionType" } ], "description": "Type of entity being mentioned: Member, Contact, or Unknown" }, "phoneNumber": { "type": "string", "description": "Phone number of the mentioned user (used when Type is Unknown for text highlighting)", "nullable": true }, "displayName": { "type": "string", "description": "Display name of the mentioned entity (contact name or member name)", "nullable": true } }, "additionalProperties": false }, "MessageModel": { "title": "MessageModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "chat" ], "type": "object", "properties": { "_t": { "type": "string" }, "prefix": { "type": "string", "description": "The message's prefix. Usually the name of the person who sent the message, which is included in the final message sent. But stored separately because of not being relevant for search", "nullable": true }, "headerContent": { "type": "string", "description": "Header of the message. Exclusive for templates.", "nullable": true }, "content": { "type": "string", "description": "The written content of the message.", "nullable": true }, "footer": { "type": "string", "description": "Footer of the message. Exclusive for templates.", "nullable": true }, "file": { "allOf": [ { "$ref": "#/components/schemas/MessageFileModel" } ], "description": "If the message includes a file, this will have its details", "nullable": true }, "thumbnail": { "allOf": [ { "$ref": "#/components/schemas/MessageFileModel" } ], "description": "In supported channels, a file message may include a thumbnail of the file before loading the full file", "nullable": true }, "quotedStatusUpdate": { "allOf": [ { "$ref": "#/components/schemas/MessageFileModel" } ], "nullable": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ChatContactModel" }, "description": "If the message type is a contact card, this will include them", "nullable": true }, "messageType": { "allOf": [ { "$ref": "#/components/schemas/MessageTypes" } ], "description": "The type of the message sent originally" }, "sentByOrganizationMember": { "allOf": [ { "$ref": "#/components/schemas/AgentReferenceIdModel" } ], "description": "Basic data of the member that sent this message, null if sent by the contact.", "nullable": true }, "isPrivate": { "type": "boolean", "description": "Private messages should not be sent to the contact. It's visible only to members" }, "location": { "allOf": [ { "$ref": "#/components/schemas/LocationModel" } ], "description": "If the message is of type location, this will include the coordinates", "nullable": true }, "question": { "oneOf": [ { "$ref": "#/components/schemas/BotQuestionModel" }, { "$ref": "#/components/schemas/ObjectiveBotQuestionModel" }, { "$ref": "#/components/schemas/SubjectiveQuestionModel" } ], "description": "If the message was sent by a bot who asked a question, this will include the presented options", "nullable": true }, "source": { "allOf": [ { "$ref": "#/components/schemas/MessageSources" } ], "description": "Where the message came from" }, "inReplyTo": { "allOf": [ { "$ref": "#/components/schemas/MessageReplyReferenceModel" } ], "description": "If the message is a reply of another message, this will include the other message's id", "nullable": true }, "messageState": { "allOf": [ { "$ref": "#/components/schemas/MessageStates" } ], "description": "The most current state of this message" }, "eventAtUTC": { "type": "string", "description": "The time the message was sent or received. Instead of the time it was saved in our database", "format": "date-time" }, "chat": { "allOf": [ { "$ref": "#/components/schemas/ChatIdReferenceModel" } ], "description": "The details of the associated chat" }, "fromContact": { "allOf": [ { "$ref": "#/components/schemas/ContactReferenceIdModel" } ], "description": "If the message was sent by a member, this will include their information", "nullable": true }, "templateId": { "type": "string", "description": "If the message is a template, this will include its id", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/MessageButtonModel" }, "description": "If the message includes buttons the contact can press, this will include them" }, "latestEdit": { "allOf": [ { "$ref": "#/components/schemas/LatestEditModel" } ], "nullable": true }, "botInstance": { "oneOf": [ { "$ref": "#/components/schemas/BotInstanceReferenceModel" }, { "$ref": "#/components/schemas/ScheduledMessageBotReferenceModel" } ], "description": "If the message was sent by a bot, this will include its instance id", "nullable": true }, "forwardedFrom": { "allOf": [ { "$ref": "#/components/schemas/MessageReferenceModel" } ], "description": "If the message was forwarded, this will include the Id of the original message", "nullable": true }, "scheduledMessage": { "allOf": [ { "$ref": "#/components/schemas/ScheduledMessageReferenceIdModel" } ], "description": "If the message was scheduled, this will include the schedule Id", "nullable": true }, "bulkSendSession": { "allOf": [ { "$ref": "#/components/schemas/BulkSendSessionReferenceModel" } ], "description": "Used to group messages by a bulk send session", "nullable": true }, "elements": { "type": "string", "nullable": true }, "mentions": { "type": "array", "items": { "$ref": "#/components/schemas/MessageMentionModel" }, "nullable": true }, "ad": { "allOf": [ { "$ref": "#/components/schemas/AdModel" } ], "description": "If the message has a click to WhatsApp Ads, this will include the ad informations", "nullable": true }, "fileId": { "type": "string", "description": "The file id that has already been saved in the organization files.", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "reactions": { "type": "array", "items": { "$ref": "#/components/schemas/MessageReactionModel" } }, "deductedAiCredits": { "type": "integer", "description": "If the message was sent by an AI, this will contain the amount of AI credits deducted", "format": "int32", "nullable": true }, "isFavorite": { "type": "boolean", "description": "If the message is marked as favorite by any member, this will be true.", "nullable": true }, "carousel": { "type": "array", "items": { "$ref": "#/components/schemas/MessageCarouselModel" }, "nullable": true }, "billable": { "allOf": [ { "$ref": "#/components/schemas/MessageBillableModel" } ], "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "MessageModel": "#/components/schemas/MessageModel", "SentMessageModel": "#/components/schemas/SentMessageModel" } } } ] }, "MessageReactionModel": { "title": "MessageReactionModel", "required": [ "emoji", "source" ], "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "emoji": { "type": "string" }, "source": { "allOf": [ { "$ref": "#/components/schemas/MessageSources" } ] }, "eventAtUTC": { "type": "string", "format": "date-time" }, "messageId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "MessageReferenceModel": { "title": "MessageReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "properties": { "eventAtUTC": { "type": "string", "format": "date-time" } }, "additionalProperties": false } ] }, "MessageReplyReferenceModel": { "title": "MessageReplyReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "properties": { "chatId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "button": { "allOf": [ { "$ref": "#/components/schemas/MessageButtonModel" } ], "nullable": true } }, "additionalProperties": false } ] }, "MessageSources": { "title": "MessageSources", "enum": [ "Contact", "Member", "External", "Bot" ], "type": "string" }, "MessageStateModel": { "title": "MessageStateModel", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/MessageStates" } ], "description": "The state of this message" }, "eventAtUTC": { "type": "string", "description": "Timestamp of the event", "format": "date-time", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/FriendlyErrorReasons" } ], "description": "Generic reason of the error", "nullable": true }, "madeBy": { "type": "string", "description": "Who (or what) made this change", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "MessageStateModel": "#/components/schemas/MessageStateModel" } } }, "MessageStates": { "title": "MessageStates", "enum": [ "Processing", "Sent", "Received", "Read", "Redacted", "Failed", "Deleted", "Submitted", "Played", "Edited", "Reaction", "Retrying", "Error" ], "type": "string" }, "MessageStatesModel": { "title": "MessageStatesModel", "required": [ "states" ], "type": "object", "properties": { "states": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/MessageStateModel" } ] } } }, "additionalProperties": false }, "MessageTypes": { "title": "MessageTypes", "enum": [ "Text", "Image", "Video", "Audio", "Sticker", "Location", "Contact", "File", "Payment", "List", "ListReply", "CallAttempt", "QuickReply", "Poll", "Gif", "Reaction", "Order", "ButtonReply", "Carousel", "Unsupported", "Url" ], "type": "string", "description": "All the possibilities of a message" }, "ModelBase": { "title": "ModelBase", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "id": { "type": "string", "description": "The Id of the object generated automatically", "example": "AB_12-xyzEXAMPLE" }, "createdAtUTC": { "type": "string", "description": "The exact time the entity was created in UTC", "format": "date-time" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "WebhookModel": "#/components/schemas/WebhookModel", "ActivityLogSimpleModel": "#/components/schemas/ActivityLogSimpleModel", "UserNotificationModel": "#/components/schemas/UserNotificationModel", "SimpleTemplateModel": "#/components/schemas/SimpleTemplateModel", "TemplateModel": "#/components/schemas/TemplateModel", "SoftDeleteModelBase": "#/components/schemas/SoftDeleteModelBase", "SectorModel": "#/components/schemas/SectorModel", "ScheduledMessageModel": "#/components/schemas/ScheduledMessageModel", "QuickAnswerModel": "#/components/schemas/QuickAnswerModel", "SimpleQuickAnswerModel": "#/components/schemas/SimpleQuickAnswerModel", "AIOrganizationAgentModel": "#/components/schemas/AIOrganizationAgentModel", "HumanOrganizationAgentModel": "#/components/schemas/HumanOrganizationAgentModel", "OrganizationAgentModel": "#/components/schemas/OrganizationAgentModel", "OrganizationFieldModel": "#/components/schemas/OrganizationFieldModel", "OrganizationDetailsModel": "#/components/schemas/OrganizationDetailsModel", "SimpleOrganizationModel": "#/components/schemas/SimpleOrganizationModel", "OrganizationFlagModel": "#/components/schemas/OrganizationFlagModel", "GroupModel": "#/components/schemas/GroupModel", "VariableModel": "#/components/schemas/VariableModel", "PlainTextVariableModel": "#/components/schemas/PlainTextVariableModel", "EncryptedVariableModel": "#/components/schemas/EncryptedVariableModel", "CurrencyCustomFieldDefinitionModel": "#/components/schemas/CurrencyCustomFieldDefinitionModel", "CustomFieldDefinitionModel": "#/components/schemas/CustomFieldDefinitionModel", "TextCustomFieldDefinitionModel": "#/components/schemas/TextCustomFieldDefinitionModel", "LogicCustomFieldDefinitionModel": "#/components/schemas/LogicCustomFieldDefinitionModel", "NumberCustomFieldDefinitionModel": "#/components/schemas/NumberCustomFieldDefinitionModel", "LinkCustomFieldDefinitionModel": "#/components/schemas/LinkCustomFieldDefinitionModel", "MemberCustomFieldDefinitionModel": "#/components/schemas/MemberCustomFieldDefinitionModel", "CNPJCustomFieldDefinitionModel": "#/components/schemas/CNPJCustomFieldDefinitionModel", "CPFCustomFieldDefinitionModel": "#/components/schemas/CPFCustomFieldDefinitionModel", "DateCustomFieldDefinitionModel": "#/components/schemas/DateCustomFieldDefinitionModel", "DecimalCustomFieldDefinitionModel": "#/components/schemas/DecimalCustomFieldDefinitionModel", "ListStringCustomFieldDefinitionModel": "#/components/schemas/ListStringCustomFieldDefinitionModel", "NotificationModel": "#/components/schemas/NotificationModel", "AdmMessageModel": "#/components/schemas/AdmMessageModel", "AdmAIUsageMessageModel": "#/components/schemas/AdmAIUsageMessageModel", "MessageModel": "#/components/schemas/MessageModel", "SentMessageModel": "#/components/schemas/SentMessageModel", "WidgetMessageModel": "#/components/schemas/WidgetMessageModel", "CreditPackageModel": "#/components/schemas/CreditPackageModel", "ContactsBoardColumnModel": "#/components/schemas/ContactsBoardColumnModel", "ContactsBoardModel": "#/components/schemas/ContactsBoardModel", "ContactRatingsModel": "#/components/schemas/ContactRatingsModel", "ContactModel": "#/components/schemas/ContactModel", "SimpleContactModel": "#/components/schemas/SimpleContactModel", "NoteModel": "#/components/schemas/NoteModel", "BasicChatModel": "#/components/schemas/BasicChatModel", "ChatModel": "#/components/schemas/ChatModel", "ChannelMetricsModel": "#/components/schemas/ChannelMetricsModel", "ChannelBaseModel": "#/components/schemas/ChannelBaseModel", "InternalChannelBaseModel": "#/components/schemas/InternalChannelBaseModel", "WelcomerChannelModel": "#/components/schemas/WelcomerChannelModel", "MembersChannelModel": "#/components/schemas/MembersChannelModel", "ExternalChannelBaseModel": "#/components/schemas/ExternalChannelBaseModel", "PhoneNumberChannelBaseModel": "#/components/schemas/PhoneNumberChannelBaseModel", "WhatsappChannelBaseModel": "#/components/schemas/WhatsappChannelBaseModel", "BrokerWhatsappChannelModel": "#/components/schemas/BrokerWhatsappChannelModel", "GupshupWhatsappChannelModel": "#/components/schemas/GupshupWhatsappChannelModel", "CloudAPIWhatsappChannelModel": "#/components/schemas/CloudAPIWhatsappChannelModel", "UsernameChannelBaseModel": "#/components/schemas/UsernameChannelBaseModel", "InstagramChannelBaseModel": "#/components/schemas/InstagramChannelBaseModel", "GupshupInstagramChannelModel": "#/components/schemas/GupshupInstagramChannelModel", "WebsiteWidgetChannelModel": "#/components/schemas/WebsiteWidgetChannelModel", "BasicBulkSendSessionModel": "#/components/schemas/BasicBulkSendSessionModel", "BulkSendSessionModel": "#/components/schemas/BulkSendSessionModel", "TaggingBotModel": "#/components/schemas/TaggingBotModel", "BotBaseModel": "#/components/schemas/BotBaseModel", "SectorForwardingBotModel": "#/components/schemas/SectorForwardingBotModel", "GreetingBotModel": "#/components/schemas/GreetingBotModel", "TemplateMessageStepModel": "#/components/schemas/TemplateMessageStepModel", "PipedriveActionModel": "#/components/schemas/PipedriveActionModel", "AsaasActionModel": "#/components/schemas/AsaasActionModel", "WebhookActionModel": "#/components/schemas/WebhookActionModel", "OneShotCronActionModel": "#/components/schemas/OneShotCronActionModel", "WaitingActionModel": "#/components/schemas/WaitingActionModel", "TimeOfDayStepModel": "#/components/schemas/TimeOfDayStepModel", "TagActionModel": "#/components/schemas/TagActionModel", "StartManualEntryActionModel": "#/components/schemas/StartManualEntryActionModel", "FlowchartActionModel": "#/components/schemas/FlowchartActionModel", "FlowchartBotEventModel": "#/components/schemas/FlowchartBotEventModel", "FlowchartBotModel": "#/components/schemas/FlowchartBotModel", "FlowchartBotStepModel": "#/components/schemas/FlowchartBotStepModel", "InteractiveStepModel": "#/components/schemas/InteractiveStepModel", "SetWaitingStateActionModel": "#/components/schemas/SetWaitingStateActionModel", "SetInactivityActionModel": "#/components/schemas/SetInactivityActionModel", "SetWaitingFlowActionModel": "#/components/schemas/SetWaitingFlowActionModel", "SetCustomFieldActionModel": "#/components/schemas/SetCustomFieldActionModel", "SetChatVisibilityActionModel": "#/components/schemas/SetChatVisibilityActionModel", "SendMessageActionModel": "#/components/schemas/SendMessageActionModel", "SectorTransferActionModel": "#/components/schemas/SectorTransferActionModel", "RegexStepModel": "#/components/schemas/RegexStepModel", "FeedbackRatingStepModel": "#/components/schemas/FeedbackRatingStepModel", "ScoreRatingStepModel": "#/components/schemas/ScoreRatingStepModel", "OptionsStepModel": "#/components/schemas/OptionsStepModel", "NotifyMemberActionModel": "#/components/schemas/NotifyMemberActionModel", "MemberTransferActionModel": "#/components/schemas/MemberTransferActionModel", "FlowchartBotManualStartedEventModel": "#/components/schemas/FlowchartBotManualStartedEventModel", "DayOfTheWeekStepModel": "#/components/schemas/DayOfTheWeekStepModel", "ConditionalActionModel": "#/components/schemas/ConditionalActionModel", "CommentBlockModel": "#/components/schemas/CommentBlockModel", "CloseChatActionModel": "#/components/schemas/CloseChatActionModel", "FlowchartBotChatStartedEventModel": "#/components/schemas/FlowchartBotChatStartedEventModel", "ChangeChatPrivateStateActionModel": "#/components/schemas/ChangeChatPrivateStateActionModel", "OrganizationAIAgentCreditsBonusPackageModel": "#/components/schemas/OrganizationAIAgentCreditsBonusPackageModel", "OrganizationAIAgentCreditsOnDemandPackageModel": "#/components/schemas/OrganizationAIAgentCreditsOnDemandPackageModel", "OrganizationAIAgentCreditsPackageModel": "#/components/schemas/OrganizationAIAgentCreditsPackageModel", "OrganizationAIAgentCreditsStarterPackageModel": "#/components/schemas/OrganizationAIAgentCreditsStarterPackageModel", "ActivityLogModel": "#/components/schemas/ActivityLogModel" } } }, "MoveRelativeToAnchor": { "title": "MoveRelativeToAnchor", "enum": [ "BeforeAnchor", "AfterAnchor" ], "type": "string" }, "NoteModel": { "title": "NoteModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" }, "pinned": { "type": "boolean" }, "createdBy": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "elements": { "type": "string", "nullable": true }, "mentions": { "type": "array", "items": { "$ref": "#/components/schemas/MessageMentionModel" }, "nullable": true } }, "additionalProperties": false } ] }, "NotificationModel": { "title": "NotificationModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "type": "object", "properties": { "activityLogType": { "allOf": [ { "$ref": "#/components/schemas/ActivityLogType" } ], "nullable": true } }, "additionalProperties": false } ], "description": "Model containing only the basic info to display a chat" }, "NotifyFirstWidgetMessage": { "title": "NotifyFirstWidgetMessage", "enum": [ "Never", "UntilClicked" ], "type": "string" }, "NotifyMemberActionModel": { "title": "NotifyMemberActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "required": [ "message", "options", "title" ], "type": "object", "properties": { "title": { "type": "string" }, "message": { "type": "string" }, "options": { "allOf": [ { "$ref": "#/components/schemas/NotifyMemberModel" } ] }, "onlyMembersAvailable": { "type": "boolean" }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "NotifyMemberModel": { "title": "NotifyMemberModel", "type": "object", "properties": { "memberIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/NotifyMemberStrategy" } ] } }, "additionalProperties": false }, "NotifyMemberStrategy": { "title": "NotifyMemberStrategy", "enum": [ "Current", "Direct" ], "type": "string" }, "NumberCustomFieldAggregationModel": { "title": "NumberCustomFieldAggregationModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldAggregationModel" }, { "type": "object", "properties": { "value": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false } ] }, "NumberCustomFieldDefinitionModel": { "title": "NumberCustomFieldDefinitionModel", "allOf": [ { "$ref": "#/components/schemas/CustomFieldDefinitionModel" }, { "type": "object", "additionalProperties": false } ] }, "NumberFlowchartVariable": { "title": "NumberFlowchartVariable", "allOf": [ { "$ref": "#/components/schemas/FlowchartVariable" }, { "type": "object", "properties": { "minValue": { "type": "integer", "format": "int32" }, "maxValue": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "NumberFlowchartVariableModel": { "title": "NumberFlowchartVariableModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartVariableModel" }, { "type": "object", "properties": { "minValue": { "type": "integer", "format": "int32" }, "maxValue": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "ObjectiveBotQuestionModel": { "title": "ObjectiveBotQuestionModel", "allOf": [ { "$ref": "#/components/schemas/BotQuestionModel" }, { "required": [ "buttonText", "options" ], "type": "object", "properties": { "buttonText": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectiveOptionModel" } } }, "additionalProperties": false } ] }, "ObjectiveOptionModel": { "title": "ObjectiveOptionModel", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "OneShotCronActionModel": { "title": "OneShotCronActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "required": [ "expression", "nextStepId", "timeZone" ], "type": "object", "properties": { "expression": { "type": "string" }, "nextStepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "contactResponseStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "timeZone": { "type": "string", "description": "IANA timezone code", "format": "time-zone-id", "example": "America/Sao_Paulo" } }, "additionalProperties": false } ] }, "OptionsStepModel": { "title": "OptionsStepModel", "allOf": [ { "$ref": "#/components/schemas/InteractiveStepModel" }, { "required": [ "text" ], "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/BotOptionModel" } }, "text": { "type": "string" }, "defaultNextStep": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "messageType": { "allOf": [ { "$ref": "#/components/schemas/MessageTypes" } ], "nullable": true } }, "additionalProperties": false } ] }, "Order": { "title": "Order", "enum": [ "Asc", "Desc" ], "type": "string" }, "OrganizationAIAgentCreditsBonusPackageModel": { "title": "OrganizationAIAgentCreditsBonusPackageModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationAIAgentCreditsPackageModel" }, { "type": "object", "additionalProperties": false } ] }, "OrganizationAIAgentCreditsOnDemandPackageModel": { "title": "OrganizationAIAgentCreditsOnDemandPackageModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationAIAgentCreditsPackageModel" }, { "type": "object", "additionalProperties": false } ] }, "OrganizationAIAgentCreditsPackageModel": { "title": "OrganizationAIAgentCreditsPackageModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "count": { "type": "integer", "description": "The total amount of credits that this package has", "format": "int32" }, "used": { "type": "integer", "description": "The amount of credits that have been used so far", "format": "int32" }, "expiresAtUTC": { "type": "string", "description": "When the credits expire. If null, the credits never expire.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationAIAgentCreditsPackageModel": "#/components/schemas/OrganizationAIAgentCreditsPackageModel", "OrganizationAIAgentCreditsBonusPackageModel": "#/components/schemas/OrganizationAIAgentCreditsBonusPackageModel", "OrganizationAIAgentCreditsOnDemandPackageModel": "#/components/schemas/OrganizationAIAgentCreditsOnDemandPackageModel", "OrganizationAIAgentCreditsStarterPackageModel": "#/components/schemas/OrganizationAIAgentCreditsStarterPackageModel" } } } ] }, "OrganizationAIAgentCreditsStarterPackageModel": { "title": "OrganizationAIAgentCreditsStarterPackageModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationAIAgentCreditsPackageModel" }, { "type": "object", "additionalProperties": false } ] }, "OrganizationAIAgentReferenceModel": { "title": "OrganizationAIAgentReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/AIStatuses" } ] }, "chatbotType": { "allOf": [ { "$ref": "#/components/schemas/BotTypes" } ] }, "botLLM": { "allOf": [ { "$ref": "#/components/schemas/AiLLMs" } ] } }, "additionalProperties": false } ] }, "OrganizationAdminInviteModel": { "title": "OrganizationAdminInviteModel", "required": [ "name" ], "type": "object", "properties": { "adminId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "name": { "type": "string" } }, "additionalProperties": false }, "OrganizationAgentModel": { "title": "OrganizationAgentModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "organizations" ], "type": "object", "properties": { "_t": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true }, "profilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "organizations": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationReferenceModel" }, { "$ref": "#/components/schemas/OrganizationReferenceForAITalkAgentModel" }, { "$ref": "#/components/schemas/OrganizationReferenceForHumanAgentModel" } ] } } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationAgentModel": "#/components/schemas/OrganizationAgentModel", "AIOrganizationAgentModel": "#/components/schemas/AIOrganizationAgentModel", "HumanOrganizationAgentModel": "#/components/schemas/HumanOrganizationAgentModel" } } } ] }, "OrganizationAgentReferenceModel": { "title": "OrganizationAgentReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "profilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "active": { "type": "boolean" }, "billable": { "type": "boolean" }, "lastBotTransferenceUTC": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationAgentReferenceModel": "#/components/schemas/OrganizationAgentReferenceModel", "OrganizationAIAgentReferenceModel": "#/components/schemas/OrganizationAIAgentReferenceModel", "OrganizationHumanAgentReferenceModel": "#/components/schemas/OrganizationHumanAgentReferenceModel" } } } ] }, "OrganizationBrokerWhatsappChannelReferenceModel": { "title": "OrganizationBrokerWhatsappChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel" }, { "type": "object", "properties": { "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelFilter" } ], "readOnly": true, "deprecated": true }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "OrganizationChannelReferenceBaseModel": { "title": "OrganizationChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/ChannelState" } ] } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationChannelReferenceBaseModel": "#/components/schemas/OrganizationChannelReferenceBaseModel", "OrganizationInternalChannelReferenceBaseModel": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel", "OrganizationWelcomerChannelReferenceModel": "#/components/schemas/OrganizationWelcomerChannelReferenceModel", "OrganizationMembersChannelReferenceModel": "#/components/schemas/OrganizationMembersChannelReferenceModel", "OrganizationExternalChannelReferenceBaseModel": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel", "OrganizationWebsiteWidgetChannelReferenceModel": "#/components/schemas/OrganizationWebsiteWidgetChannelReferenceModel", "OrganizationPhoneNumberChannelReferenceBaseModel": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel", "OrganizationWhatsappChannelReferenceBaseModel": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel", "OrganizationBrokerWhatsappChannelReferenceModel": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel", "OrganizationGupshupWhatsappChannelReferenceModel": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel", "OrganizationCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel", "OrganizationUsernameChannelReferenceBaseModel": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel", "OrganizationInstagramChannelReferenceBaseModel": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel", "OrganizationGupshupInstagramChannelReferenceModel": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel" } } } ] }, "OrganizationCloudAPIWhatsappChannelReferenceModel": { "title": "OrganizationCloudAPIWhatsappChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "OrganizationDetailsModel": { "title": "OrganizationDetailsModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "financeEmail": { "type": "string", "nullable": true }, "financeWhatsapp": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "socialReason": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "cep": { "type": "string", "nullable": true }, "road": { "type": "string", "nullable": true }, "neighbourhood": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "complement": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "iconUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" } }, "additionalProperties": false } ] }, "OrganizationExternalChannelReferenceBaseModel": { "title": "OrganizationExternalChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationExternalChannelReferenceBaseModel": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel", "OrganizationWebsiteWidgetChannelReferenceModel": "#/components/schemas/OrganizationWebsiteWidgetChannelReferenceModel", "OrganizationPhoneNumberChannelReferenceBaseModel": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel", "OrganizationWhatsappChannelReferenceBaseModel": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel", "OrganizationBrokerWhatsappChannelReferenceModel": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel", "OrganizationGupshupWhatsappChannelReferenceModel": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel", "OrganizationCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel", "OrganizationUsernameChannelReferenceBaseModel": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel", "OrganizationInstagramChannelReferenceBaseModel": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel", "OrganizationGupshupInstagramChannelReferenceModel": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel" } } } ] }, "OrganizationFieldModel": { "title": "OrganizationFieldModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "type": "object", "properties": { "salesCloser": { "allOf": [ { "$ref": "#/components/schemas/CloserAgentReferenceModel" } ], "nullable": true }, "tags": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SimpleTagReferenceModel" }, { "$ref": "#/components/schemas/TagModel" } ] }, "nullable": true }, "links": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "OrganizationFieldReferenceModel": { "title": "OrganizationFieldReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "properties": { "salesCloser": { "allOf": [ { "$ref": "#/components/schemas/CloserAgentReferenceModel" } ], "nullable": true }, "tags": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SimpleTagReferenceModel" }, { "$ref": "#/components/schemas/TagModel" } ] }, "nullable": true }, "links": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false } ] }, "OrganizationFileModel": { "title": "OrganizationFileModel", "required": [ "organization" ], "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "organization": { "allOf": [ { "$ref": "#/components/schemas/OrganizationReferenceIdModel" } ] }, "url": { "type": "string", "description": "A URL to the uploaded file", "format": "uri", "nullable": true, "example": "https://example.com" }, "contentType": { "type": "string", "description": "The original content-type of the file", "nullable": true }, "originalName": { "type": "string", "description": "The original name of the file", "nullable": true }, "originalSizeBytes": { "type": "integer", "description": "The original size of the file, expressed in bytes", "format": "int64", "nullable": true }, "data": { "type": "string", "description": "Binary data of the file, when applicable", "format": "byte", "nullable": true }, "fileType": { "allOf": [ { "$ref": "#/components/schemas/FileTypes" } ] }, "useCount": { "type": "integer", "format": "int32" }, "botIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "createdAtUTC": { "type": "string", "format": "date-time" }, "thumbnail": { "type": "string", "nullable": true }, "deletedAtUTC": { "type": "string", "format": "date-time", "nullable": true }, "organizationMember": { "allOf": [ { "$ref": "#/components/schemas/AgentReferenceIdModel" } ], "nullable": true }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/FileVisibility" } ], "nullable": true } }, "additionalProperties": false }, "OrganizationFlagModel": { "title": "OrganizationFlagModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "OrganizationGupshupInstagramChannelReferenceModel": { "title": "OrganizationGupshupInstagramChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "OrganizationGupshupWhatsappChannelReferenceModel": { "title": "OrganizationGupshupWhatsappChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel" }, { "type": "object", "properties": { "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelFilter" } ], "readOnly": true, "deprecated": true }, "wabaState": { "allOf": [ { "$ref": "#/components/schemas/WABAState" } ] }, "host": { "type": "string", "nullable": true }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "OrganizationHumanAgentReferenceModel": { "title": "OrganizationHumanAgentReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "required": [ "allowedChannel", "allowedChannelSession", "allowedContactsBoard", "allowedQuickAnswers", "allowedSector", "emailAddress" ], "type": "object", "properties": { "emailAddress": { "type": "string" }, "reassign": { "allOf": [ { "$ref": "#/components/schemas/ReassignOptions" } ] }, "allowedSector": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedSectorModel" } ] }, "allowedChannel": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelModel" } ] }, "allowedChannelSession": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelSessionModel" } ] }, "allowedContactsBoard": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedContactsBoardModel" } ] }, "allowReports": { "type": "boolean" }, "allowedTemplates": { "type": "boolean" }, "allowedContacts": { "type": "boolean" }, "allowedQuickAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CrudPermission" } }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Permissions" } }, "permissionActions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionAction" } } }, "additionalProperties": false } ] }, "OrganizationInstagramChannelReferenceBaseModel": { "title": "OrganizationInstagramChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationInstagramChannelReferenceBaseModel": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel", "OrganizationGupshupInstagramChannelReferenceModel": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel" } } } ] }, "OrganizationInternalChannelReferenceBaseModel": { "title": "OrganizationInternalChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationInternalChannelReferenceBaseModel": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel", "OrganizationWelcomerChannelReferenceModel": "#/components/schemas/OrganizationWelcomerChannelReferenceModel", "OrganizationMembersChannelReferenceModel": "#/components/schemas/OrganizationMembersChannelReferenceModel" } } } ] }, "OrganizationInviteModel": { "title": "OrganizationInviteModel", "required": [ "allowedChannel", "allowedChannelSession", "allowedContactsBoard", "allowedQuickAnswer", "allowedSector", "email" ], "type": "object", "properties": { "email": { "type": "string" }, "billable": { "type": "boolean" }, "allowedSector": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedSectorModel" } ] }, "allowedChannel": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelModel" } ] }, "allowedChannelSession": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelSessionModel" } ] }, "allowedContactsBoard": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedContactsBoardModel" } ] }, "allowReport": { "type": "boolean" }, "allowedTemplate": { "type": "boolean" }, "allowedContact": { "type": "boolean" }, "allowedQuickAnswer": { "type": "array", "items": { "$ref": "#/components/schemas/CrudPermission" } }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Permissions" } }, "validUntilUTC": { "type": "string", "format": "date-time", "nullable": true }, "permissionActions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionAction" }, "nullable": true } }, "additionalProperties": false }, "OrganizationMemberActivationStatusModel": { "title": "OrganizationMemberActivationStatusModel", "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "active": { "type": "boolean" }, "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "OrganizationMembersChannelReferenceModel": { "title": "OrganizationMembersChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "OrganizationPhoneNumberChannelReferenceBaseModel": { "title": "OrganizationPhoneNumberChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationPhoneNumberChannelReferenceBaseModel": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel", "OrganizationWhatsappChannelReferenceBaseModel": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel", "OrganizationBrokerWhatsappChannelReferenceModel": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel", "OrganizationGupshupWhatsappChannelReferenceModel": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel", "OrganizationCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel" } } } ] }, "OrganizationPreferencesDetailsModel": { "title": "OrganizationPreferencesDetailsModel", "required": [ "closeChatBehavior", "reassignBehavior" ], "type": "object", "properties": { "closeChatBehavior": { "allOf": [ { "$ref": "#/components/schemas/CloseChatBehaviorModel" } ] }, "reassignBehavior": { "allOf": [ { "$ref": "#/components/schemas/ReassignBehaviorModel" } ] } }, "additionalProperties": false }, "OrganizationReferenceForAITalkAgentModel": { "title": "OrganizationReferenceForAITalkAgentModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationReferenceModel" }, { "type": "object", "additionalProperties": false } ] }, "OrganizationReferenceForHumanAgentModel": { "title": "OrganizationReferenceForHumanAgentModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationReferenceModel" }, { "type": "object", "properties": { "allowedSectors": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedSectorModel" } ] }, "allowedChannels": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelModel" } ] }, "allowedChannelsSession": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelSessionModel" } ] }, "allowedContactsBoard": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedContactsBoardModel" } ] }, "allowedQuickAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/CrudPermission" } }, "allowReports": { "type": "boolean" }, "allowedTemplates": { "type": "boolean" }, "allowedContacts": { "type": "boolean" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Permissions" } }, "pinnedChatsId": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "permissionActions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionAction" } } }, "additionalProperties": false } ] }, "OrganizationReferenceIdModel": { "title": "OrganizationReferenceIdModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "OrganizationReferenceModel": { "title": "OrganizationReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "iconUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "active": { "type": "boolean" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationReferenceModel": "#/components/schemas/OrganizationReferenceModel", "OrganizationReferenceForAITalkAgentModel": "#/components/schemas/OrganizationReferenceForAITalkAgentModel", "OrganizationReferenceForHumanAgentModel": "#/components/schemas/OrganizationReferenceForHumanAgentModel" } } } ] }, "OrganizationUsernameChannelReferenceBaseModel": { "title": "OrganizationUsernameChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationUsernameChannelReferenceBaseModel": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel", "OrganizationInstagramChannelReferenceBaseModel": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel", "OrganizationGupshupInstagramChannelReferenceModel": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel" } } } ] }, "OrganizationWebsiteWidgetChannelReferenceModel": { "title": "OrganizationWebsiteWidgetChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel" }, { "required": [ "domains" ], "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "OrganizationWelcomerChannelReferenceModel": { "title": "OrganizationWelcomerChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel" }, { "type": "object", "properties": { "channelType": { "allOf": [ { "$ref": "#/components/schemas/ChannelFilter" } ], "readOnly": true, "deprecated": true } }, "additionalProperties": false } ] }, "OrganizationWhatsappChannelReferenceBaseModel": { "title": "OrganizationWhatsappChannelReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "OrganizationWhatsappChannelReferenceBaseModel": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel", "OrganizationBrokerWhatsappChannelReferenceModel": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel", "OrganizationGupshupWhatsappChannelReferenceModel": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel", "OrganizationCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel" } } } ] }, "PNDNChannelEvent": { "title": "PNDNChannelEvent", "allOf": [ { "$ref": "#/components/schemas/ChannelEvent" }, { "type": "object", "properties": { "status": { "type": "string" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "PaginationBehavior": { "title": "PaginationBehavior", "enum": [ "GetSliceOnly", "CountAllAndGetSlice", "CountOnly" ], "type": "string" }, "PaginationInfo": { "title": "PaginationInfo", "type": "object", "properties": { "totalItems": { "type": "integer", "description": "The total amount of items that can be queried.", "format": "int32" }, "skipped": { "type": "integer", "description": "How many items were skipped. How many there are before the first item in the list", "format": "int32" }, "took": { "type": "integer", "description": "The amount of items taken after the specified offset. This number equals the number of items in the list", "format": "int32" }, "maxTake": { "type": "integer", "description": "The maximum amount of items this route can return in a single request", "format": "int32" }, "searchEngine": { "allOf": [ { "$ref": "#/components/schemas/SearchEngines" } ], "description": "Which search engine was chosen to execute the query. Only useful for debugging purposes" } }, "additionalProperties": false }, "PaginationOfAIAgentDocumentModel": { "title": "PaginationOfAIAgentDocumentModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDocumentModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfAIAgentQAModel": { "title": "PaginationOfAIAgentQAModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentQAModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfActivityLogModel": { "title": "PaginationOfActivityLogModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityLogModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfBasicBulkSendSessionModel": { "title": "PaginationOfBasicBulkSendSessionModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BasicBulkSendSessionModel" }, { "$ref": "#/components/schemas/BulkSendSessionModel" } ] }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfBasicChatModel": { "title": "PaginationOfBasicChatModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfBotBaseModel": { "title": "PaginationOfBotBaseModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "$ref": "#/components/schemas/TaggingBotModel" }, { "$ref": "#/components/schemas/SectorForwardingBotModel" }, { "$ref": "#/components/schemas/GreetingBotModel" }, { "$ref": "#/components/schemas/FlowchartBotModel" } ] }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfBotSnapshotModel": { "title": "PaginationOfBotSnapshotModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BotSnapshotModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfBulkSendMessageModel": { "title": "PaginationOfBulkSendMessageModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BulkSendMessageModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfBulkSendScheduleModel": { "title": "PaginationOfBulkSendScheduleModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BulkSendScheduleModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfContactRatingsModel": { "title": "PaginationOfContactRatingsModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRatingsModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfFlowchartBotInstanceModel": { "title": "PaginationOfFlowchartBotInstanceModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FlowchartBotInstanceModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfFlowchartBotModel": { "title": "PaginationOfFlowchartBotModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FlowchartBotModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfFlowchartManualStartStep": { "title": "PaginationOfFlowchartManualStartStep", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FlowchartManualStartStep" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfOrganizationFileModel": { "title": "PaginationOfOrganizationFileModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationFileModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfScheduledMessageModel": { "title": "PaginationOfScheduledMessageModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledMessageModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfSimpleContactModel": { "title": "PaginationOfSimpleContactModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SimpleContactModel" }, { "$ref": "#/components/schemas/ContactModel" } ] }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfSimpleQuickAnswerModel": { "title": "PaginationOfSimpleQuickAnswerModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleQuickAnswerModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfSimpleTemplateModel": { "title": "PaginationOfSimpleTemplateModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleTemplateModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfStickerModel": { "title": "PaginationOfStickerModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/StickerModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfTagModel": { "title": "PaginationOfTagModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TagModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfUserNotificationModel": { "title": "PaginationOfUserNotificationModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PaginationOfWebsiteCrawlerModel": { "title": "PaginationOfWebsiteCrawlerModel", "type": "object", "properties": { "page": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "description": "Information for pagination purposes", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteCrawlerModel" }, "description": "The items in the selected slice. Will be empty if the operation is count-only" } }, "additionalProperties": false }, "PermissionAction": { "title": "PermissionAction", "enum": [ "MessageDelete", "TagsCrud", "SectorsCrud", "ChannelCrud", "ChatbotCrud", "AIAgentsCrud", "AgentsCrud", "InviteAgents", "WebhooksCrud", "OrganizationCrud", "CustomFieldsCrud", "BulkSend", "BoardContactsCrud", "ContactsCrud", "ChatWithAi", "VariablesCrud", "ScheduledMessagesView", "ChatMemberGroupCrud", "FinancialActions" ], "type": "string" }, "PermissionOrganizationMemberModel": { "title": "PermissionOrganizationMemberModel", "required": [ "allowedChannel", "allowedChannelSession", "allowedContact", "allowedContactsBoard", "allowedSector", "allowedTemplate", "allowQuickAnswer", "allowReport", "id" ], "type": "object", "properties": { "id": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Permissions" } }, "allowedSector": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedSectorModel" } ] }, "allowedChannel": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelModel" } ] }, "allowedChannelSession": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelSessionModel" } ] }, "allowedContactsBoard": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedContactsBoardModel" } ] }, "allowReport": { "type": "boolean" }, "allowedTemplate": { "type": "boolean" }, "allowedContact": { "type": "boolean" }, "allowQuickAnswer": { "type": "array", "items": { "$ref": "#/components/schemas/CrudPermission" } }, "permissionActions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionAction" }, "nullable": true } }, "additionalProperties": false }, "Permissions": { "title": "Permissions", "enum": [ "Member", "Operator", "Admin", "Owner" ], "type": "string" }, "PhoneNumberChannelBaseModel": { "title": "PhoneNumberChannelBaseModel", "allOf": [ { "$ref": "#/components/schemas/ExternalChannelBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "phoneNumber": { "type": "string", "nullable": true }, "callBehavior": { "allOf": [ { "$ref": "#/components/schemas/CallBehaviorModel" } ], "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "PhoneNumberChannelBaseModel": "#/components/schemas/PhoneNumberChannelBaseModel", "WhatsappChannelBaseModel": "#/components/schemas/WhatsappChannelBaseModel", "BrokerWhatsappChannelModel": "#/components/schemas/BrokerWhatsappChannelModel", "GupshupWhatsappChannelModel": "#/components/schemas/GupshupWhatsappChannelModel", "CloudAPIWhatsappChannelModel": "#/components/schemas/CloudAPIWhatsappChannelModel" } } } ] }, "PhoneNumberWabaStatus": { "title": "PhoneNumberWabaStatus", "enum": [ "CreateWaba", "MigrateWaba" ], "type": "string" }, "PinnedChatsModel": { "title": "PinnedChatsModel", "required": [ "chats" ], "type": "object", "properties": { "chats": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BasicChatModel" }, { "$ref": "#/components/schemas/ChatModel" } ], "description": "Model containing only the basic info to display a chat" } } }, "additionalProperties": false }, "PipedriveActionModel": { "title": "PipedriveActionModel", "allOf": [ { "$ref": "#/components/schemas/WebhookActionModel" }, { "type": "object", "additionalProperties": false } ] }, "PlainTextVariableModel": { "title": "PlainTextVariableModel", "allOf": [ { "$ref": "#/components/schemas/VariableModel" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } }, "additionalProperties": false } ] }, "PositionModel": { "title": "PositionModel", "type": "object", "properties": { "x": { "type": "integer", "format": "int32" }, "y": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProblemDetails": { "title": "ProblemDetails", "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { }, "discriminator": { "propertyName": "_t", "mapping": { "ProblemDetails": "#/components/schemas/ProblemDetails", "HttpValidationProblemDetails": "#/components/schemas/HttpValidationProblemDetails" } } }, "QuickAnswerAgentReferenceModel": { "title": "QuickAnswerAgentReferenceModel", "allOf": [ { "$ref": "#/components/schemas/AgentReferenceModel" }, { "type": "object", "additionalProperties": false } ] }, "QuickAnswerModel": { "title": "QuickAnswerModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "content", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "content": { "type": "string" }, "organizationMember": { "allOf": [ { "$ref": "#/components/schemas/QuickAnswerAgentReferenceModel" } ], "nullable": true }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "QuickAnswerVisibility": { "title": "QuickAnswerVisibility", "enum": [ "All", "Mine" ], "type": "string" }, "QuickAnswersProperty": { "title": "QuickAnswersProperty", "enum": [ "Name", "Content", "OrganizationMember", "CreatedAtUTC" ], "type": "string" }, "ReactionModel": { "title": "ReactionModel", "required": [ "messageId", "organizationId" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "messageId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "emoji": { "type": "string", "description": "If null or empty will remove the reaction.", "nullable": true } }, "additionalProperties": false }, "ReadState": { "title": "ReadState", "enum": [ "All", "Read", "Unread" ], "type": "string" }, "ReassignBehaviorModel": { "title": "ReassignBehaviorModel", "type": "object", "properties": { "behavior": { "allOf": [ { "$ref": "#/components/schemas/ReassignBehaviors" } ] }, "bot": { "allOf": [ { "$ref": "#/components/schemas/ManualStartPath" } ], "nullable": true } }, "additionalProperties": false }, "ReassignBehaviors": { "title": "ReassignBehaviors", "enum": [ "RemoveMember", "ExecuteBot" ], "type": "string" }, "ReassignOptions": { "title": "ReassignOptions", "enum": [ "Off", "Auto", "Always" ], "type": "string" }, "RedactReason": { "title": "RedactReason", "enum": [ "PrivatedBySomeoneElse", "InDisallowedSector", "InDisallowedChannel" ], "type": "string" }, "ReferenceBaseModel": { "title": "ReferenceBaseModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "_t", "name" ], "type": "object", "properties": { "_t": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ReferenceBaseModel": "#/components/schemas/ReferenceBaseModel", "SimpleTagReferenceModel": "#/components/schemas/SimpleTagReferenceModel", "TagModel": "#/components/schemas/TagModel", "SectorHistoryReferenceModel": "#/components/schemas/SectorHistoryReferenceModel", "SectorReferenceModel": "#/components/schemas/SectorReferenceModel", "OrganizationReferenceForAITalkAgentModel": "#/components/schemas/OrganizationReferenceForAITalkAgentModel", "OrganizationReferenceForHumanAgentModel": "#/components/schemas/OrganizationReferenceForHumanAgentModel", "OrganizationReferenceModel": "#/components/schemas/OrganizationReferenceModel", "ChatFilterModel": "#/components/schemas/ChatFilterModel", "ChatChannelReferenceBaseModel": "#/components/schemas/ChatChannelReferenceBaseModel", "ChatInternalChannelReferenceBaseModel": "#/components/schemas/ChatInternalChannelReferenceBaseModel", "ChatWelcomerChannelReferenceModel": "#/components/schemas/ChatWelcomerChannelReferenceModel", "ChatMembersChannelReferenceModel": "#/components/schemas/ChatMembersChannelReferenceModel", "ChatExternalChannelReferenceBaseModel": "#/components/schemas/ChatExternalChannelReferenceBaseModel", "ChatWebsiteWidgetChannelReferenceModel": "#/components/schemas/ChatWebsiteWidgetChannelReferenceModel", "ChatPhoneNumberChannelReferenceBaseModel": "#/components/schemas/ChatPhoneNumberChannelReferenceBaseModel", "ChatWhatsappChannelReferenceBaseModel": "#/components/schemas/ChatWhatsappChannelReferenceBaseModel", "ChatBrokerWhatsappChannelReferenceModel": "#/components/schemas/ChatBrokerWhatsappChannelReferenceModel", "ChatGupshupWhatsappChannelReferenceModel": "#/components/schemas/ChatGupshupWhatsappChannelReferenceModel", "ChatCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/ChatCloudAPIWhatsappChannelReferenceModel", "ChatUsernameChannelReferenceBaseModel": "#/components/schemas/ChatUsernameChannelReferenceBaseModel", "ChatInstagramChannelReferenceBaseModel": "#/components/schemas/ChatInstagramChannelReferenceBaseModel", "ChatGupshupInstagramChannelReferenceModel": "#/components/schemas/ChatGupshupInstagramChannelReferenceModel", "OrganizationChannelReferenceBaseModel": "#/components/schemas/OrganizationChannelReferenceBaseModel", "OrganizationInternalChannelReferenceBaseModel": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel", "OrganizationWelcomerChannelReferenceModel": "#/components/schemas/OrganizationWelcomerChannelReferenceModel", "OrganizationMembersChannelReferenceModel": "#/components/schemas/OrganizationMembersChannelReferenceModel", "OrganizationExternalChannelReferenceBaseModel": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel", "OrganizationWebsiteWidgetChannelReferenceModel": "#/components/schemas/OrganizationWebsiteWidgetChannelReferenceModel", "OrganizationPhoneNumberChannelReferenceBaseModel": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel", "OrganizationWhatsappChannelReferenceBaseModel": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel", "OrganizationBrokerWhatsappChannelReferenceModel": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel", "OrganizationGupshupWhatsappChannelReferenceModel": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel", "OrganizationCloudAPIWhatsappChannelReferenceModel": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel", "OrganizationUsernameChannelReferenceBaseModel": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel", "OrganizationInstagramChannelReferenceBaseModel": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel", "OrganizationGupshupInstagramChannelReferenceModel": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel", "ScheduledMessageChannelReferenceModel": "#/components/schemas/ScheduledMessageChannelReferenceModel" } } } ] }, "ReferenceNullableNameBaseModel": { "title": "ReferenceNullableNameBaseModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "ReferenceNullableNameBaseModel": "#/components/schemas/ReferenceNullableNameBaseModel", "ContactReferenceModel": "#/components/schemas/ContactReferenceModel", "ScheduledMessageContactReferenceModel": "#/components/schemas/ScheduledMessageContactReferenceModel" } } } ] }, "RegexOptionModel": { "title": "RegexOptionModel", "required": [ "pattern", "stepId" ], "type": "object", "properties": { "target": { "allOf": [ { "$ref": "#/components/schemas/RegexOptionTarget" } ] }, "pattern": { "type": "string" }, "stepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false }, "RegexOptionTarget": { "title": "RegexOptionTarget", "enum": [ "Content", "FileName", "All" ], "type": "string" }, "RegexStepModel": { "title": "RegexStepModel", "allOf": [ { "$ref": "#/components/schemas/InteractiveStepModel" }, { "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/RegexOptionModel" } }, "text": { "type": "string", "nullable": true }, "canUseLastMessage": { "type": "boolean" }, "sendMessage": { "type": "boolean" } }, "additionalProperties": false } ] }, "RelativeMessagesResponseModel": { "title": "RelativeMessagesResponseModel", "required": [ "messages" ], "type": "object", "properties": { "hasMessagesBeforeAllowedOrganizationPlan": { "type": "boolean" }, "messages": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "$ref": "#/components/schemas/SentMessageModel" } ] } } }, "additionalProperties": false }, "ReorderChatFilterModel": { "title": "ReorderChatFilterModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "organizationId", "position" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "position": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "ReorderModel": { "title": "ReorderModel", "required": [ "anchorId", "position", "toMoveId" ], "type": "object", "properties": { "toMoveId": { "type": "string", "description": "The Id of the entity to be moved", "example": "AB_12-xyzEXAMPLE" }, "anchorId": { "type": "string", "description": "The Id of the entity that will be the anchor, the reference point to move the entity", "example": "AB_12-xyzEXAMPLE" }, "position": { "allOf": [ { "$ref": "#/components/schemas/MoveRelativeToAnchor" } ], "description": "What position to move the entity to, relative to the anchor." } }, "additionalProperties": false }, "ReplyInAudio": { "title": "ReplyInAudio", "enum": [ "Never", "Always", "WhenQuestionIsAudio" ], "type": "string" }, "ReportContactModel": { "title": "ReportContactModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "profilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "totalChats": { "type": "integer", "format": "int32" }, "opened": { "type": "integer", "format": "int32" }, "closed": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "ReportSectorModel": { "title": "ReportSectorModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "totalChats": { "type": "integer", "format": "int32" }, "opened": { "type": "integer", "format": "int32" }, "openedWithMember": { "type": "integer", "format": "int32" }, "closed": { "type": "integer", "format": "int32" }, "participated": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "ReportTagModel": { "title": "ReportTagModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "emoji": { "type": "string", "nullable": true }, "color": { "allOf": [ { "$ref": "#/components/schemas/TagColor" } ] }, "totalChats": { "type": "integer", "format": "int32" }, "opened": { "type": "integer", "format": "int32" }, "openedWithMember": { "type": "integer", "format": "int32" }, "closed": { "type": "integer", "format": "int32" }, "participated": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "RequiredEditAddressModel": { "title": "RequiredEditAddressModel", "allOf": [ { "$ref": "#/components/schemas/EditAddressModel" }, { "required": [ "addressLine1", "addressLine2", "city", "country", "state", "zipCode" ], "type": "object", "properties": { "addressLine1": { "minLength": 1, "type": "string" }, "addressLine2": { "minLength": 1, "type": "string" }, "city": { "minLength": 1, "type": "string" }, "country": { "minLength": 1, "type": "string" }, "state": { "minLength": 1, "type": "string" }, "zipCode": { "minLength": 1, "type": "string" } }, "additionalProperties": false } ] }, "RestrictionInfoModel": { "title": "RestrictionInfoModel", "required": [ "expiration", "restrictionType" ], "type": "object", "properties": { "restrictionType": { "type": "string" }, "expiration": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ReturnColumnModel": { "title": "ReturnColumnModel", "type": "object", "properties": { "columnName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReviewChannelEvent": { "title": "ReviewChannelEvent", "allOf": [ { "$ref": "#/components/schemas/ChannelEvent" }, { "type": "object", "properties": { "actionDate": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": false } ] }, "ScheduledMessageBotReferenceModel": { "title": "ScheduledMessageBotReferenceModel", "allOf": [ { "$ref": "#/components/schemas/BotInstanceReferenceModel" }, { "required": [ "triggerName" ], "type": "object", "properties": { "triggerName": { "type": "string" } }, "additionalProperties": false } ] }, "ScheduledMessageCanceledReason": { "title": "ScheduledMessageCanceledReason", "enum": [ "Deleted", "ChannelDeleted", "ContactDeleted", "ContactBlocked", "OrganizationDeleted", "MemberDeleted", "TemplateDeleted", "ChatbotDeleted", "MemberSentMessage", "ContactSentMessage", "ClosedChat" ], "type": "string" }, "ScheduledMessageChannelReferenceModel": { "title": "ScheduledMessageChannelReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ScheduledMessageContactReferenceModel": { "title": "ScheduledMessageContactReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceNullableNameBaseModel" }, { "type": "object", "properties": { "phoneNumber": { "type": "string", "nullable": true }, "profilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" } }, "additionalProperties": false } ] }, "ScheduledMessageModel": { "title": "ScheduledMessageModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "channel", "contact" ], "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ScheduledMessageStatus" } ] }, "templateId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "templateLabel": { "type": "string", "nullable": true }, "bot": { "allOf": [ { "$ref": "#/components/schemas/ScheduledMessageBotReferenceModel" } ], "nullable": true }, "params": { "type": "array", "items": { "type": "string" }, "nullable": true }, "message": { "type": "string", "nullable": true }, "dateSendAtUtc": { "type": "string", "format": "date-time" }, "contact": { "allOf": [ { "$ref": "#/components/schemas/ScheduledMessageContactReferenceModel" } ] }, "channel": { "allOf": [ { "$ref": "#/components/schemas/ScheduledMessageChannelReferenceModel" } ] }, "messageReference": { "allOf": [ { "$ref": "#/components/schemas/MessageReferenceModel" } ], "nullable": true }, "organizationMember": { "allOf": [ { "$ref": "#/components/schemas/AgentReferenceIdModel" } ], "nullable": true }, "cancelUpon": { "type": "array", "items": { "$ref": "#/components/schemas/CancelScheduledMessageUpon" } }, "prefix": { "type": "string", "nullable": true }, "initialData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "botInstance": { "oneOf": [ { "$ref": "#/components/schemas/BotInstanceReferenceModel" }, { "$ref": "#/components/schemas/ScheduledMessageBotReferenceModel" } ], "nullable": true }, "bulkSession": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "cancelReason": { "allOf": [ { "$ref": "#/components/schemas/ScheduledMessageCanceledReason" } ], "nullable": true }, "isPrivate": { "type": "boolean" } }, "additionalProperties": false } ] }, "ScheduledMessageReferenceIdModel": { "title": "ScheduledMessageReferenceIdModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "ScheduledMessageReferenceModel": { "title": "ScheduledMessageReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "properties": { "organizationMemberId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "ScheduledMessageStatus": { "title": "ScheduledMessageStatus", "enum": [ "Pending", "Error", "Sent", "Canceled" ], "type": "string" }, "ScoreRating": { "title": "ScoreRating", "enum": [ "NoRating", "Awful", "Bad", "Average", "Good", "Excellent" ], "type": "string" }, "ScoreRatingOptionModel": { "title": "ScoreRatingOptionModel", "required": [ "rating", "stepId", "text" ], "type": "object", "properties": { "text": { "type": "string" }, "stepId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "rating": { "allOf": [ { "$ref": "#/components/schemas/ScoreRating" } ] }, "emoji": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScoreRatingOrderBy": { "title": "ScoreRatingOrderBy", "enum": [ "PositiveToNegative", "NegativeToPositive" ], "type": "string" }, "ScoreRatingStepModel": { "title": "ScoreRatingStepModel", "allOf": [ { "$ref": "#/components/schemas/InteractiveStepModel" }, { "required": [ "repository", "text" ], "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreRatingOptionModel" } }, "text": { "type": "string" }, "repository": { "type": "string" }, "orderBy": { "allOf": [ { "$ref": "#/components/schemas/ScoreRatingOrderBy" } ], "nullable": true }, "messageType": { "allOf": [ { "$ref": "#/components/schemas/MessageTypes" } ], "nullable": true } }, "additionalProperties": false } ] }, "SearchEngines": { "title": "SearchEngines", "enum": [ "Unspecified", "Pipeline", "Atlas", "Hybrid" ], "type": "string" }, "SearchQuery": { "title": "SearchQuery", "type": "object", "properties": { "searchData": { "type": "array", "items": { "$ref": "#/components/schemas/SpreadsheetQueryKeyModel" } } }, "additionalProperties": false }, "SectorConditionalModel": { "title": "SectorConditionalModel", "allOf": [ { "$ref": "#/components/schemas/ConditionalModel" }, { "type": "object", "properties": { "sectors": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "SectorForwardingBotModel": { "title": "SectorForwardingBotModel", "allOf": [ { "$ref": "#/components/schemas/BotBaseModel" }, { "required": [ "body", "prefix", "sectors" ], "type": "object", "properties": { "body": { "type": "string" }, "sectors": { "type": "array", "items": { "$ref": "#/components/schemas/SectorReferenceIdModel" } }, "prefix": { "type": "string" }, "sendTransferSectorMessage": { "type": "boolean" } }, "additionalProperties": false } ] }, "SectorHistoryReferenceIdModel": { "title": "SectorHistoryReferenceIdModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "SectorHistoryReferenceModel": { "title": "SectorHistoryReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceBaseModel" }, { "type": "object", "properties": { "sectorId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "default": { "type": "boolean" }, "order": { "type": "number", "format": "float" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "enteredAt": { "type": "string", "format": "date-time" }, "firstMemberReplyMessage": { "allOf": [ { "$ref": "#/components/schemas/MessageReferenceModel" } ], "nullable": true }, "firstContactMessage": { "allOf": [ { "$ref": "#/components/schemas/MessageReferenceModel" } ], "nullable": true } }, "additionalProperties": false } ] }, "SectorModel": { "title": "SectorModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "default": { "type": "boolean" }, "order": { "type": "number", "format": "float" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "SectorReferenceIdModel": { "title": "SectorReferenceIdModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "SectorReferenceModel": { "title": "SectorReferenceModel", "allOf": [ { "$ref": "#/components/schemas/ReferenceBaseModel" }, { "type": "object", "properties": { "default": { "type": "boolean" }, "order": { "type": "number", "format": "float" }, "groupIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } } }, "additionalProperties": false } ] }, "SectorTransferActionModel": { "title": "SectorTransferActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "type": "object", "properties": { "sectorId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/SectorTransferStrategy" } ] }, "onlyAllowedMember": { "type": "boolean" }, "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "SectorTransferStrategy": { "title": "SectorTransferStrategy", "enum": [ "Direct", "LastSectorFromSameChatChannel" ], "type": "string" }, "SendMessageActionModel": { "title": "SendMessageActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartActionModel" }, { "type": "object", "properties": { "organizationFileId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "message": { "type": "string", "nullable": true }, "isPrivate": { "type": "boolean" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/MessageButtonModel" }, "nullable": true } }, "additionalProperties": false } ] }, "SendOrganizationInviteModel": { "title": "SendOrganizationInviteModel", "required": [ "allowedChannel", "allowedChannelSession", "allowedContact", "allowedContactsBoard", "allowedQuickAnswer", "allowedSector", "allowedTemplate", "allowReport", "email", "organizationId" ], "type": "object", "properties": { "organizationId": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "email": { "maxLength": 200, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+@[a-zA-Z0-9-]+.[a-zA-Z0-9-.]+$", "type": "string" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Permissions" } }, "allowedSector": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedSectorModel" } ] }, "allowedChannel": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelModel" } ] }, "allowedChannelSession": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedChannelSessionModel" } ] }, "allowedContactsBoard": { "allOf": [ { "$ref": "#/components/schemas/MemberAllowedContactsBoardModel" } ] }, "allowReport": { "type": "boolean" }, "allowedTemplate": { "type": "boolean" }, "allowedContact": { "type": "boolean" }, "allowedQuickAnswer": { "type": "array", "items": { "$ref": "#/components/schemas/CrudPermission" } }, "permissionActions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionAction" }, "nullable": true } }, "additionalProperties": false }, "SentMessageModel": { "title": "SentMessageModel", "allOf": [ { "$ref": "#/components/schemas/MessageModel" }, { "type": "object", "properties": { "contactId": { "type": "string", "description": "When a message or template is sent, this will include the contactId", "example": "AB_12-xyzEXAMPLE" } }, "additionalProperties": false } ] }, "SerializedException": { "title": "SerializedException", "type": "object", "properties": { "stackTrace": { "type": "array", "items": { "type": "string" } }, "exceptionType": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "innerExceptions": { "type": "array", "items": { "$ref": "#/components/schemas/SerializedException" } } }, "additionalProperties": false }, "SetChatVisibilityActionModel": { "title": "SetChatVisibilityActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartActionModel" }, { "required": [ "visibility" ], "type": "object", "properties": { "visibility": { "allOf": [ { "$ref": "#/components/schemas/ChatVisibility" } ] } }, "additionalProperties": false } ] }, "SetCustomFieldActionGroupsModel": { "title": "SetCustomFieldActionGroupsModel", "required": [ "parseCulture" ], "type": "object", "properties": { "contactFieldDefinition": { "allOf": [ { "$ref": "#/components/schemas/ContactFieldDefinition" } ], "nullable": true }, "customFieldDefinitionId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "value": { "type": "string", "nullable": true }, "parseCulture": { "type": "string", "description": "The Language Code ID", "format": "culture-info-id", "example": "pt-BR" } }, "additionalProperties": false }, "SetCustomFieldActionModel": { "title": "SetCustomFieldActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartBotStepModel" }, { "type": "object", "properties": { "nextStepId": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "onFail": { "type": "string", "nullable": true, "example": "AB_12-xyzEXAMPLE" }, "customFieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/SetCustomFieldActionGroupsModel" } } }, "additionalProperties": false } ] }, "SetInactivityActionModel": { "title": "SetInactivityActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartActionModel" }, { "type": "object", "properties": { "hasInactivity": { "type": "boolean" } }, "additionalProperties": false } ] }, "SetWaitingFlowActionModel": { "title": "SetWaitingFlowActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartActionModel" }, { "type": "object", "properties": { "hasWaitingFlow": { "type": "boolean" } }, "additionalProperties": false } ] }, "SetWaitingStateActionModel": { "title": "SetWaitingStateActionModel", "allOf": [ { "$ref": "#/components/schemas/FlowchartActionModel" }, { "type": "object", "properties": { "waiting": { "type": "boolean" } }, "additionalProperties": false } ] }, "SimpleAITalkAgentModel": { "title": "SimpleAITalkAgentModel", "allOf": [ { "$ref": "#/components/schemas/SimpleTalkAgentModel" }, { "required": [ "_t" ], "type": "object", "properties": { "_t": { "type": "string" }, "signature": { "type": "string", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/AIStatuses" } ] }, "chatbotType": { "allOf": [ { "$ref": "#/components/schemas/BotTypes" } ] }, "botLLM": { "allOf": [ { "$ref": "#/components/schemas/AiLLMs" } ] } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "SimpleAITalkAgentModel": "#/components/schemas/SimpleAITalkAgentModel", "FullAITalkAgentModel": "#/components/schemas/FullAITalkAgentModel" } } } ] }, "SimpleAgentReferenceModel": { "title": "SimpleAgentReferenceModel", "allOf": [ { "$ref": "#/components/schemas/IdentifierReferenceBaseModel" }, { "type": "object", "additionalProperties": false } ] }, "SimpleContactModel": { "title": "SimpleContactModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "channelIds", "organizationMembers", "tags" ], "type": "object", "properties": { "_t": { "type": "string" }, "name": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "lid": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "profilePictureUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "isBlocked": { "type": "boolean" }, "groupIdentifier": { "type": "string", "nullable": true }, "contactType": { "allOf": [ { "$ref": "#/components/schemas/ContactType" } ] }, "organizationMembers": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "channelIds": { "type": "array", "items": { "type": "string", "example": "AB_12-xyzEXAMPLE" } }, "tags": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SimpleTagReferenceModel" }, { "$ref": "#/components/schemas/TagModel" } ] } }, "lastActiveUTC": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "_t", "mapping": { "SimpleContactModel": "#/components/schemas/SimpleContactModel", "ContactModel": "#/components/schemas/ContactModel" } } } ] }, "SimpleHumanTalkAgentModel": { "title": "SimpleHumanTalkAgentModel", "allOf": [ { "$ref": "#/components/schemas/SimpleTalkAgentModel" }, { "required": [ "emailAddress" ], "type": "object", "properties": { "emailAddress": { "type": "string" } }, "additionalProperties": false } ] }, "SimpleOrganizationModel": { "title": "SimpleOrganizationModel", "allOf": [ { "$ref": "#/components/schemas/ModelBase" }, { "required": [ "_t", "blockSignatureBehavior", "channels", "chatbotRunningBehavior", "chats", "closeChatBehavior", "flags", "inactivityFlowBehavior", "name", "organizationMembers", "reassignBehavior", "sectors", "transferBehavior", "waitingFlowBehavior" ], "type": "object", "properties": { "_t": { "type": "string" }, "name": { "type": "string" }, "reassignBehavior": { "allOf": [ { "$ref": "#/components/schemas/ReassignBehaviorModel" } ] }, "blockSignatureBehavior": { "allOf": [ { "$ref": "#/components/schemas/BlockSignatureBehaviorModel" } ] }, "chatbotRunningBehavior": { "allOf": [ { "$ref": "#/components/schemas/ChatbotRunningBehaviorModel" } ] }, "closeChatBehavior": { "allOf": [ { "$ref": "#/components/schemas/CloseChatBehaviorModel" } ] }, "inactivityFlowBehavior": { "allOf": [ { "$ref": "#/components/schemas/InactivityFlowBehaviorModel" } ] }, "waitingFlowBehavior": { "allOf": [ { "$ref": "#/components/schemas/WaitingFlowBehaviorModel" } ] }, "transferBehavior": { "allOf": [ { "$ref": "#/components/schemas/TransferBehaviorModel" } ] }, "botShortcuts": { "type": "array", "items": { "$ref": "#/components/schemas/BotShortcutModel" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupModel" } }, "iconUrl": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com" }, "maxMembers": { "type": "integer", "format": "int32" }, "hasSentFirstMessage": { "type": "boolean" }, "maxDaysMessageHistoric": { "type": "integer", "format": "int32", "nullable": true }, "exceedingCredits": { "type": "integer", "format": "int32" }, "contractStatus": { "allOf": [ { "$ref": "#/components/schemas/ContractStatus" } ] }, "contractPlan": { "allOf": [ { "$ref": "#/components/schemas/ContractPlan" } ], "nullable": true }, "contractIdentifier": { "type": "string", "example": "AB_12-xyzEXAMPLE" }, "freeUntilUTC": { "type": "string", "format": "date-time" }, "hasImplementation": { "type": "boolean" }, "chats": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "pendingInvites": { "type": "integer", "format": "int32" }, "adminInvites": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationAdminInviteModel" } }, "organizationMembers": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationAIAgentReferenceModel" }, { "$ref": "#/components/schemas/OrganizationHumanAgentReferenceModel" } ] } }, "channels": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationInternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWelcomerChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationMembersChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationExternalChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWebsiteWidgetChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationPhoneNumberChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationWhatsappChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationBrokerWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationGupshupWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationCloudAPIWhatsappChannelReferenceModel" }, { "$ref": "#/components/schemas/OrganizationUsernameChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationInstagramChannelReferenceBaseModel" }, { "$ref": "#/components/schemas/OrganizationGupshupInstagramChannelReferenceModel" } ] } }, "sectors": { "type": "array", "items": { "$ref": "#/components/schemas/SectorReferenceModel" } }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationFlagModel" } }, "defaultBusinessHour": { "allOf": [ { "$ref": "#/components/schemas/BusinessHourReferenceModel" } ], "nullable": true }, "organizationFields": { "allOf": [ { "$ref": "#/components/schemas/OrganizationFieldReferenceModel" } ], "nullable": true }, "llmDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AILLMDetailsModel" }, "readOnly": true }, "hasContractPendence": { "type": "boolean", "readOnly": true }, "features": { "allOf": [ { "$ref": "#/components/schemas/UTalkFeatures" } ], "description": "\nDescribes the features available to an organization based on their contract plan and the organization creation date.\n\nSupports only some primitive and other simple values:\n