{ "openapi": "3.1.0", "info": { "title": "Heyy API", "version": "2.0.0" }, "servers": [ { "url": "https://api.heyy.io/v2" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": {}, "parameters": {} }, "paths": { "/api_webhooks": { "get": { "summary": "Get webhooks", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "isActive": { "type": "boolean" }, "channelId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "type", "url", "isActive", "createdAt", "updatedAt" ] } } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": [] } } } } }, "x-mint": { "href": "/api-reference/v2/get-api_webhooks" } }, "post": { "summary": "Create webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tenantId": { "type": "string" }, "type": { "type": "string", "enum": [ "WHATSAPP_MESSAGE_RECEIVED", "WHATSAPP_MESSAGE_STATUS", "SMS_MESSAGE_RECEIVED", "SMS_MESSAGE_STATUS", "EMAIL_MESSAGE_RECEIVED", "EMAIL_MESSAGE_STATUS", "INSTAGRAM_MESSAGE_RECEIVED", "INSTAGRAM_MESSAGE_STATUS", "INSTAGRAM_MESSAGE_ECHO" ] }, "url": { "type": "string" }, "channelId": { "type": "string" } }, "required": [ "tenantId", "type", "url" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "isActive": { "type": "boolean" }, "channelId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "type", "url", "isActive", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "type": "string", "url": "string", "isActive": true, "channelId": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/post-api_webhooks" } } }, "/api_webhooks/{webhookId}": { "put": { "summary": "Update webhook", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "isActive": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "isActive": { "type": "boolean" }, "channelId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "type", "url", "isActive", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "type": "string", "url": "string", "isActive": true, "channelId": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/put-api_webhooks-webhookId" } }, "delete": { "summary": "Delete webhook", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string" } }, "notFoundIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "deletedIds", "notFoundIds" ], "additionalProperties": false } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "deletedIds": [], "notFoundIds": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/delete-api_webhooks-webhookId" } } }, "/attributes": { "get": { "summary": "Get attributes", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "externalId": { "type": "string" }, "isVisibleQuickEdit": { "type": "boolean" }, "isVisibleContactsTable": { "type": "boolean" }, "isVisibleContactCreate": { "type": "boolean" }, "description": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "isVisibleQuickEdit", "isVisibleContactsTable", "isVisibleContactCreate", "createdAt", "updatedAt" ] } } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": [] } } } } }, "x-mint": { "href": "/api-reference/v2/get-attributes" } }, "post": { "summary": "Create attribute", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "externalId": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*$" }, "isVisibleQuickEdit": { "type": "boolean" }, "isVisibleContactsTable": { "type": "boolean" }, "isVisibleContactCreate": { "type": "boolean" } }, "required": [ "name", "externalId" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "externalId": { "type": "string" }, "isVisibleQuickEdit": { "type": "boolean" }, "isVisibleContactsTable": { "type": "boolean" }, "isVisibleContactCreate": { "type": "boolean" }, "description": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "isVisibleQuickEdit", "isVisibleContactsTable", "isVisibleContactCreate", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "name": "string", "type": "string", "externalId": "string", "isVisibleQuickEdit": true, "isVisibleContactsTable": true, "isVisibleContactCreate": true, "description": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/post-attributes" } } }, "/attributes/{attributeId}": { "delete": { "summary": "Delete attribute", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string" } }, "notFoundIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "deletedIds", "notFoundIds" ], "additionalProperties": false } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "deletedIds": [], "notFoundIds": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/delete-attributes-attributeId" } } }, "/{channelId}/broadcasts": { "get": { "summary": "Get broadcasts", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "broadcasts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "workflowId": { "type": "string" }, "isScheduled": { "type": "boolean" }, "isReoccurring": { "type": "boolean" }, "scheduledAt": { "type": "string" }, "recurrenceRules": {}, "variables": {}, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "workflowId", "isScheduled", "isReoccurring", "status", "createdAt", "updatedAt" ] } } }, "required": [ "broadcasts" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "broadcasts": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/get-channelId-broadcasts" } }, "post": { "summary": "Create broadcast", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "workflowId": { "type": "string", "format": "uuid" }, "isScheduled": { "type": "boolean" }, "scheduledAt": { "type": "string", "format": "date-time" }, "isReoccurring": { "type": "boolean" }, "recurrenceRules": { "type": "array", "items": { "type": "string" } }, "messageTemplateId": { "type": "string", "format": "uuid" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phoneNumber": { "type": [ "string", "null" ] }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*$" }, "value": { "type": "string" } }, "required": [ "externalId", "value" ] } }, "labels": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } } }, "maxItems": 5000 }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } } }, "required": [ "name", "workflowId" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "workflowId": { "type": "string" }, "isScheduled": { "type": "boolean" }, "isReoccurring": { "type": "boolean" }, "scheduledAt": { "type": "string" }, "recurrenceRules": {}, "variables": {}, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "workflowId", "isScheduled", "isReoccurring", "status", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "name": "string", "workflowId": "string", "isScheduled": true, "isReoccurring": true, "scheduledAt": "string", "recurrenceRules": null, "variables": null, "status": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/post-channelId-broadcasts" } } }, "/{channelId}/broadcasts/{broadcastId}": { "get": { "summary": "Get broadcast by id", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "workflowId": { "type": "string" }, "isScheduled": { "type": "boolean" }, "isReoccurring": { "type": "boolean" }, "scheduledAt": { "type": "string" }, "recurrenceRules": {}, "variables": {}, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "workflowId", "isScheduled", "isReoccurring", "status", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "name": "string", "workflowId": "string", "isScheduled": true, "isReoccurring": true, "scheduledAt": "string", "recurrenceRules": null, "variables": null, "status": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/get-channelId-broadcasts-broadcastId" } }, "put": { "summary": "Update broadcast", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "workflowId": { "type": "string", "format": "uuid" }, "isScheduled": { "type": "boolean" }, "scheduledAt": { "type": [ "string", "null" ], "format": "date-time" }, "isReoccurring": { "type": "boolean" }, "recurrenceRules": { "type": [ "array", "null" ], "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "workflowId": { "type": "string" }, "isScheduled": { "type": "boolean" }, "isReoccurring": { "type": "boolean" }, "scheduledAt": { "type": "string" }, "recurrenceRules": {}, "variables": {}, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "workflowId", "isScheduled", "isReoccurring", "status", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "name": "string", "workflowId": "string", "isScheduled": true, "isReoccurring": true, "scheduledAt": "string", "recurrenceRules": null, "variables": null, "status": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/put-channelId-broadcasts-broadcastId" } }, "delete": { "summary": "Delete broadcast", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string" } }, "notFoundIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "deletedIds", "notFoundIds" ], "additionalProperties": false } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "deletedIds": [], "notFoundIds": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/delete-channelId-broadcasts-broadcastId" } } }, "/{channelId}/broadcasts/{broadcastId}/start": { "post": { "summary": "Start broadcast", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mediaId": { "type": "string", "format": "uuid" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "status": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/post-channelId-broadcasts-broadcastId-start" } } }, "/{channelId}/broadcasts/{broadcastId}/recipients": { "get": { "summary": "Get broadcast recipients", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "contactId": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "contactId", "status", "createdAt" ] } } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": [] } } } } }, "x-mint": { "href": "/api-reference/v2/get-channelId-broadcasts-broadcastId-recipients" } }, "post": { "summary": "Add recipients to broadcast", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactsIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "contactsIds" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "contactId": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "contactId", "status", "createdAt" ] } } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": [] } } } } }, "x-mint": { "href": "/api-reference/v2/post-channelId-broadcasts-broadcastId-recipients" } }, "delete": { "summary": "Remove recipients from broadcast", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string" } }, "notFoundIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "deletedIds", "notFoundIds" ], "additionalProperties": false } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "deletedIds": [], "notFoundIds": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/delete-channelId-broadcasts-broadcastId-recipients" } } }, "/business": { "get": { "summary": "Get business", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "name": "string", "email": "string", "phoneNumber": "string", "address": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/get-business" } } }, "/channels": { "get": { "summary": "Get channels", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "vendorDetails": {}, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "status", "createdAt", "updatedAt" ] } } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": [] } } } } }, "x-mint": { "href": "/api-reference/v2/get-channels" } } }, "/channels/{channelId}": { "get": { "summary": "Get channel by id", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "vendorDetails": {}, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "type", "status", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "name": "string", "type": "string", "status": "string", "vendorDetails": null, "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/get-channels-channelId" } } }, "/{channelId}/chats": { "get": { "summary": "Get chats", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "channelId": { "type": "string" }, "contactId": { "type": "string" }, "handleId": { "type": "string" }, "status": { "type": "string" }, "isUnread": { "type": "boolean" }, "assignedUserId": { "type": "string" }, "assignedTeamId": { "type": "string" }, "lastMessageAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "channelId", "contactId", "status", "isUnread", "createdAt", "updatedAt" ] } } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": [] } } } } }, "x-mint": { "href": "/api-reference/v2/get-channelId-chats" } } }, "/{channelId}/chats/{chatId}": { "get": { "summary": "Get chat by id", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "channelId": { "type": "string" }, "contactId": { "type": "string" }, "handleId": { "type": "string" }, "status": { "type": "string" }, "isUnread": { "type": "boolean" }, "assignedUserId": { "type": "string" }, "assignedTeamId": { "type": "string" }, "lastMessageAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "channelId", "contactId", "status", "isUnread", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "channelId": "string", "contactId": "string", "handleId": "string", "status": "string", "isUnread": true, "assignedUserId": "string", "assignedTeamId": "string", "lastMessageAt": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/get-channelId-chats-chatId" } }, "put": { "summary": "Update chat", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isUnread": { "type": "boolean" }, "status": { "type": "string", "enum": [ "OPEN", "CLOSED", "SNOOZED" ] }, "assignedUserId": { "type": [ "string", "null" ], "format": "uuid" }, "assignedTeamId": { "type": [ "string", "null" ], "format": "uuid" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "channelId": { "type": "string" }, "contactId": { "type": "string" }, "handleId": { "type": "string" }, "status": { "type": "string" }, "isUnread": { "type": "boolean" }, "assignedUserId": { "type": "string" }, "assignedTeamId": { "type": "string" }, "lastMessageAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "channelId", "contactId", "status", "isUnread", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "channelId": "string", "contactId": "string", "handleId": "string", "status": "string", "isUnread": true, "assignedUserId": "string", "assignedTeamId": "string", "lastMessageAt": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/put-channelId-chats-chatId" } } }, "/contacts": { "get": { "summary": "Get contacts", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "firstName", "lastName", "phoneNumber", "createdAt", "updatedAt" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt" ] } } }, "required": [ "contacts" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "contacts": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/get-contacts" } }, "post": { "summary": "Create contact", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ], "format": "email" }, "phoneNumber": { "type": [ "string", "null" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*$" }, "value": { "type": "string" } }, "required": [ "externalId", "value" ] } } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "firstName": "string", "lastName": "string", "phoneNumber": "string", "email": "string", "labels": [], "attributes": [], "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/post-contacts" } } }, "/contacts/{contactId}": { "get": { "summary": "Get contact by id", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "firstName": "string", "lastName": "string", "phoneNumber": "string", "email": "string", "labels": [], "attributes": [], "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/get-contacts-contactId" } }, "put": { "summary": "Update contact", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*$" }, "value": { "type": "string" } }, "required": [ "externalId", "value" ] } } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "firstName": "string", "lastName": "string", "phoneNumber": "string", "email": "string", "labels": [], "attributes": [], "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/put-contacts-contactId" } }, "delete": { "summary": "Delete contact", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string" } }, "notFoundIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "deletedIds", "notFoundIds" ], "additionalProperties": false } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "deletedIds": [], "notFoundIds": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/delete-contacts-contactId" } } }, "/contacts/{contactId}/attributes": { "post": { "summary": "Add contact attribute", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*$" }, "value": { "type": "string" } }, "required": [ "externalId", "value" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } } }, "required": [ "id", "attributes" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "attributes": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/post-contacts-contactId-attributes" } }, "delete": { "summary": "Remove contact attribute", "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*$" } }, "required": [ "externalId" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } } }, "required": [ "id", "attributes" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "attributes": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/delete-contacts-contactId-attributes" } } }, "/upload_file": { "post": { "summary": "Upload file", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "File to upload" }, "format": { "type": "string", "description": "File format" } }, "required": [ "file", "format" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "number" }, "format": { "type": "string" }, "url": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "size", "format", "url", "createdAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "name": "string", "size": 0, "format": "string", "url": "string", "createdAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/post-upload_file" } } }, "/labels": { "get": { "summary": "Get labels", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "createdAt", "updatedAt" ] } } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": [] } } } } }, "x-mint": { "href": "/api-reference/v2/get-labels" } }, "post": { "summary": "Create label", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "createdAt", "updatedAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "name": "string", "color": "string", "createdAt": "string", "updatedAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/post-labels" } } }, "/labels/{labelId}": { "delete": { "summary": "Delete label", "parameters": [ { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "deletedIds": { "type": "array", "items": { "type": "string" } }, "notFoundIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "deletedIds", "notFoundIds" ], "additionalProperties": false } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "deletedIds": [], "notFoundIds": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/delete-labels-labelId" } } }, "/message_templates": { "get": { "summary": "Get message templates", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "messageTemplates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "category": { "type": "string" }, "language": { "type": "string" }, "components": { "type": "array", "items": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt", "updatedAt" ] } } }, "required": [ "messageTemplates" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "messageTemplates": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/get-message_templates" } } }, "/{channelId}/whatsapp_messages/send": { "post": { "summary": "Send WhatsApp message", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "type": { "type": "string", "enum": [ "TEMPLATE" ] }, "fileId": { "type": "string", "format": "uuid" }, "messageTemplateId": { "type": "string", "format": "uuid" }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } }, "scheduledAt": { "type": "string", "format": "date-time" } }, "required": [ "phoneNumber", "type", "messageTemplateId" ] }, { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "type": { "type": "string", "enum": [ "AUDIO" ] }, "fileId": { "type": "string", "format": "uuid" }, "scheduledAt": { "type": "string", "format": "date-time" } }, "required": [ "phoneNumber", "type", "fileId" ] }, { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "type": { "type": "string", "enum": [ "DOCUMENT", "IMAGE", "VIDEO" ] }, "bodyText": { "type": "string", "maxLength": 4096 }, "fileId": { "type": "string", "format": "uuid" }, "scheduledAt": { "type": "string", "format": "date-time" } }, "required": [ "phoneNumber", "type", "fileId" ] }, { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT" ] }, "bodyText": { "type": "string", "maxLength": 4096 }, "scheduledAt": { "type": "string", "format": "date-time" } }, "required": [ "phoneNumber", "type", "bodyText" ] } ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "phoneNumber": { "type": "string" }, "message": {}, "status": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "phoneNumber", "status", "createdAt" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "id": "string", "phoneNumber": "string", "message": null, "status": "string", "createdAt": "string" } } } } } }, "x-mint": { "href": "/api-reference/v2/post-channelId-whatsapp_messages-send" } } }, "/{channelId}/workflows": { "get": { "summary": "Get automations", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": { "workflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "steps": { "type": "array", "items": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt", "updatedAt" ] } } }, "required": [ "workflows" ] } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": { "workflows": [] } } } } } }, "x-mint": { "href": "/api-reference/v2/get-channelId-workflows" } } }, "/{channelId}/workflows/{workflowId}": { "post": { "summary": "Trigger automation", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } }, "scheduledAt": { "type": "string", "format": "date-time" } }, "required": [ "phoneNumber" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "properties": {} } }, "required": [ "success", "data" ], "additionalProperties": false }, "example": { "success": true, "data": {} } } } } }, "x-mint": { "href": "/api-reference/v2/post-channelId-workflows-workflowId" } } } } }