--- updatedAt: 2026-09-04T07:06:48.000Z agentTools: projectIndex: https://documentation.indigitall.com/llms.txt --- # Bulk create contacts Bulk create contacts. If a contact with the same `contactCode` and `channelType` already exists, it will be ignored. A maximum of 250 contacts can be created in a single request. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "2.0.0", "title": "INDIGITALL API", "x-logo": { "url": "https://console.indigitall.com/images/logo_verdeblanco@2x.png", "backgroundColor": "#0F3B7A" }, "description": "\n### Introduction:\nThis documentation describes every endpoint of Indigitall's API v2\n\nAPI BASE URL: https://api.indigitall.com/v2\n\n### Authentication:\n\nMost of the endpoints of the API needs an Authorization header.\n\nThere are two Authorization ways:\n\n- If your intention is to manage API calls with a server-side script you have to create a Server key through Indigitall's console.\n\n You can set the following Authorization Header : 'Authorization: ServerKey {ServerKey}'\n- If your intention is to integrate this API for front-end users POST /auth endpoint authorizes a user and returns an access token.\n\n You can set the following Authorization Header : 'Authorization: Bearer {Token}'\n" }, "security": [ { "Authorization": [] } ], "tags": [ { "name": "chat-contact", "description": "Endpoints to manage contacts for chat-service-v2", "x-displayName": "Chat - Contact" } ], "x-tagGroups": [ { "name": "Chat Service", "tags": [ "chat-configuration", "chat-channel", "chat-contact", "chat-integration", "chat-task", "chat-campaign", "chat-send", "chat-multimedia", "chat-slicing", "chat-tag", "chat-contact-list", "chat-cc-agent", "chat-cc-permissions-profile", "chat-cc-weekly-schedule", "chat-cc-special-days-schedule", "chat-cc-conversation", "chat-cc-agent-group", "chat-cc-contact-comment", "chat-cc-form", "chat-stats", "chat-internal" ] }, { "name": "Customer Service", "tags": [ "customer-service-adviser", "customer-service-customer", "customer-service-customer-csv", "customer-service-customer-field", "customer-service-customer-journey", "customer-service-customer-journey-template", "customer-service-customer-journey-control", "customer-service-customer-send", "customer-service-stats", "customer-service-webhook-template", "customer-service-segment", "customer-service-audience", "customer-service-application", "customer-service-journeywaitqueue", "customer-service-task", "customer-service-cdpeventtype", "customer-service-cdpeventtypetemplate", "customer-service-internal" ] }, { "name": "Email Service", "tags": [ "es-configuration", "es-configurationDomain", "es-configurationDomainEmail", "es-footer", "es-audience", "es-contact", "es-category", "es-campaign", "es-campaign-block", "es-campaign block-column", "es-campaign-multimedia", "es-shipment", "es-attachment", "es-statistics", "es-webhook", "es-tasks" ] }, { "name": "InApp Service", "tags": [ "inapp-configuration", "inapp-campaign", "inapp-schema", "inapp-topic", "inapp-multimedia", "inapp-form", "inapp-stats", "inapp-audience", "inapp-task" ] }, { "name": "SMS Service", "tags": [ "sms-campaign", "sms-configuration", "sms-contact", "sms-send", "sms-stats", "sms-topic", "sms-cost", "sms-webhook", "sms-private" ] }, { "name": "Wallet Service", "tags": [ "wallet-project", "wallet-images", "wallet-tasks", "wallet-notifications", "wallet-template", "wallet-loyalty-pass", "wallet-loyalty-template", "wallet-offer-pass", "wallet-offer-template", "wallet-generic-pass", "wallet-generic-template" ] }, { "name": "Stats Service", "tags": [ "stats-service-chat", "stats-service-cs", "stats-service-report", "stats-service-wallet", "stats-service-meta" ] }, { "name": "ChatGen service", "tags": [ "icc-chatgen-gateway-agent", "icc-chatgen-gateway-api-tool", "icc-chatgen-gateway-configured-custom-tool", "icc-chatgen-gateway-conversation", "icc-chatgen-gateway-custom-tool", "icc-chatgen-gateway-document", "icc-chatgen-gateway-file", "icc-chatgen-gateway-instance-config", "icc-chatgen-gateway-router-agent-tool", "icc-chatgen-gateway-router-agent" ] }, { "name": "AI Assitant service", "tags": [ "ai-generator-campaign" ] }, { "name": "Meta Service", "tags": [ "meta-cloudapi", "meta-configuration", "meta-webhook", "meta-business", "meta-templates", "meta-upload" ] }, { "name": "Push Live Service", "tags": [ "push-live-configuration", "push-live-ios-class", "push-live-activity", "push-live-send" ] }, { "name": "Pathbot", "tags": [ "pathbot-agents", "pathbot-applications", "pathbot-documents", "pathbot-flows", "pathbot-tools", "pathbot-nodes", "pathbot-ingestion-sources", "pathbot-evaluation", "pathbot-skills" ] }, { "name": "Link Service", "tags": [ "link-short-domain" ] } ], "servers": [ { "url": "https://api.indigitall.com/v2" } ], "paths": { "/chat/{applicationId}/contact": { "post": { "tags": [ "chat-contact" ], "summary": "Bulk create contacts", "description": "Bulk create contacts. If a contact with the same `contactCode` and `channelType` already exists, it will be ignored.\nA maximum of 250 contacts can be created in a single request.\n", "x-eov-operation-handler": "contact.controller", "operationId": "createContacts", "x-gateway-endpoint": "chatServiceV2", "x-gateway-check-permission": { "include-application-data": true, "account-features": [ "CHAT_V2_ENABLED" ] }, "parameters": [ { "$ref": "#/components/parameters/CHS_ApplicationId_PathParameter" } ], "requestBody": { "$ref": "#/components/requestBodies/CHS_Contact_Bulk_Create_Body" }, "responses": { "200": { "$ref": "#/components/responses/CHS_Contacts_Post_Response" }, "201": { "$ref": "#/components/responses/CHS_Contacts_Post_Response" }, "400": { "$ref": "#/components/responses/CHS_BadRequest_Response" }, "403": { "$ref": "#/components/responses/CHS_Forbidden_Response" }, "500": { "$ref": "#/components/responses/CHS_ServerError_Response" }, "default": { "$ref": "#/components/responses/Default" } } } } }, "components": { "securitySchemes": { "Authorization": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Authorization for accesing endpoints , must be in one of the following format:\n- **Bearer {token}**\n- **ServerKey {key}**\n" } }, "schemas": { "CHS_Id_Property": { "type": "integer", "format": "int32", "minimum": 0, "description": "Identifier", "example": 1234 }, "CHS_ApplicationId_Property": { "type": "integer", "format": "int32", "minimum": 0, "description": "Application identifier", "example": 1234 }, "CHS_DateTime_Property": { "type": "string", "format": "date-time", "description": "Date and time", "example": "2021-08-25T15:00:00Z" }, "CHS_ContactCode_Property": { "type": "string", "description": "The contactCode is a unique identifier assigned to each contact within a specific channel", "example": "34666777888" }, "CHS_Contact_Schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/CHS_Contact_Id_Property" }, "createdAt": { "$ref": "#/components/schemas/CHS_Contact_CreatedAt_Property" }, "updatedAt": { "$ref": "#/components/schemas/CHS_Contact_UpdatedAt_Property" }, "applicationId": { "$ref": "#/components/schemas/CHS_ApplicationId_Property" }, "name": { "$ref": "#/components/schemas/CHS_Contact_Name_Property" }, "contactCode": { "$ref": "#/components/schemas/CHS_ContactCode_Property" }, "externalCode": { "$ref": "#/components/schemas/CHS_Contact_ExternalCode_Property" }, "channelType": { "$ref": "#/components/schemas/CHS_Channel_Type_Property" }, "contactCodeStartsWith": { "$ref": "#/components/schemas/CHS_Contact_ContactCodeStartsWith_Property" }, "language": { "$ref": "#/components/schemas/CHS_Contact_Language_Property" }, "proactiveEnabled": { "$ref": "#/components/schemas/CHS_Contact_ProactiveEnabled_Property" }, "reactiveEnabled": { "$ref": "#/components/schemas/CHS_Contact_ReactiveEnabled_Property" }, "context": { "$ref": "#/components/schemas/CHS_Contact_Context_Property" }, "lastMessageId": { "$ref": "#/components/schemas/CHS_Contact_LastMessageId_Property" }, "disclaimerSentAt": { "$ref": "#/components/schemas/CHS_Contact_DisclaimerSentAt_Property" } } }, "CHS_Contact_Create_Item_Schema": { "type": "object", "required": [ "contactCode", "channelType" ], "properties": { "contactCode": { "$ref": "#/components/schemas/CHS_ContactCode_Property" }, "channelType": { "$ref": "#/components/schemas/CHS_Channel_Type_Property" }, "externalCode": { "$ref": "#/components/schemas/CHS_Contact_ExternalCode_Property" }, "name": { "$ref": "#/components/schemas/CHS_Contact_Name_Property" }, "language": { "$ref": "#/components/schemas/CHS_Contact_Language_Property" }, "proactiveEnabled": { "$ref": "#/components/schemas/CHS_Contact_ProactiveEnabled_Property" }, "reactiveEnabled": { "$ref": "#/components/schemas/CHS_Contact_ReactiveEnabled_Property" }, "context": { "$ref": "#/components/schemas/CHS_Contact_Context_Property" } } }, "CHS_Contact_Id_Property": { "allOf": [ { "description": "Contact's internal unique ID." }, { "$ref": "#/components/schemas/CHS_Id_Property" } ] }, "CHS_Contact_CreatedAt_Property": { "allOf": [ { "description": "Date and time when the contact was created." }, { "$ref": "#/components/schemas/CHS_DateTime_Property" } ] }, "CHS_Contact_UpdatedAt_Property": { "allOf": [ { "description": "Date and time when the contact was last updated." }, { "$ref": "#/components/schemas/CHS_DateTime_Property" } ] }, "CHS_Contact_Name_Property": { "type": "string", "nullable": true, "description": "Contact's name.", "example": "John Doe" }, "CHS_Contact_ExternalCode_Property": { "type": "string", "nullable": true, "description": "An external identifier for the contact.", "example": "user-ext-123" }, "CHS_Contact_ContactCodeStartsWith_Property": { "type": "string", "description": "The starting substring of the contact code.", "example": "user-" }, "CHS_Contact_Language_Property": { "type": "string", "nullable": true, "description": "The language (and locale) of the contact. Example: 'en-US', 'es-ES', etc.", "example": "en-US" }, "CHS_Contact_ProactiveEnabled_Property": { "type": "boolean", "nullable": true, "description": "Controls proactive messaging:\n- `true`: Always allow proactive messages.\n- `false`: Never allow proactive messages.\n- `null`: Use the application's default setting.\n", "default": null }, "CHS_Contact_ReactiveEnabled_Property": { "type": "boolean", "description": "Controls reactive messaging:\n- `true`: Allow integration responses.\n- `false`: Block integration responses.\n", "default": true }, "CHS_Contact_Context_Property": { "type": "object", "nullable": true, "additionalProperties": true, "description": "A JSON object to store custom key-value data for the contact.", "example": { "plan": "premium", "last_order_id": 789 } }, "CHS_Contact_LastMessageId_Property": { "type": "integer", "format": "int64", "nullable": true, "description": "The ID of the last message sent to or received from this contact.", "example": 12345678 }, "CHS_Contact_DisclaimerSentAt_Property": { "allOf": [ { "description": "Date and time when the first-response disclaimer was enqueued for this contact." }, { "$ref": "#/components/schemas/CHS_DateTime_Property" } ], "nullable": true }, "CHS_Channel_Type_Property": { "type": "string", "description": "Channel type is used to determine the communication way to send or receive messages.\n\nThe available channel types are:\n- `cloud_api` for WhatsApp Cloud API\n- `web_chat` for WebChat (browser/app embedded chat)\n", "enum": [ "cloud_api", "web_chat" ], "example": "cloud_api" } }, "responses": { "Default": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "description": "The HTTP status code indicating an error.", "example": 500 }, "message": { "type": "string", "description": "A brief message describing the error.", "example": "An unexpected error occurred." } }, "required": [ "statusCode", "message" ], "additionalProperties": false } } } }, "CHS_ServerError_Response": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "statusCode": { "type": "integer", "description": "Status code", "example": 500 }, "errorCode": { "type": "string", "description": "Error code", "example": "INTERNAL_SERVER_ERROR" }, "message": { "type": "string", "description": "Error message", "example": "Internal server error." } } } } } }, "CHS_Forbidden_Response": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "statusCode": { "type": "integer", "description": "Status code", "example": 403 }, "errorCode": { "type": "string", "description": "Error code", "example": "FORBIDDEN" }, "message": { "type": "string", "description": "Error message", "example": "Forbidden." } } } } } }, "CHS_BadRequest_Response": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "statusCode": { "type": "integer", "description": "Status code", "example": 400 }, "errorCode": { "type": "string", "description": "Error code", "example": "BAD_REQUEST" }, "message": { "type": "string", "description": "Error message", "example": "Bad request." } } } } } }, "CHS_Contacts_Post_Response": { "description": "A list of contact objects.", "content": { "application/json": { "schema": { "required": [ "statusCode", "message", "data" ], "type": "object", "additionalProperties": false, "properties": { "statusCode": { "type": "integer", "example": 200 }, "message": { "type": "string", "example": "OK" }, "code": { "type": "string", "enum": [ "SUCCESS", "PARTIAL_SUCCESS", "NO_CHANGES" ], "description": "Optional code for additional context (e.g., \"PARTIAL_SUCCESS\" if some contacts were not created).\n\n- SUCCESS: All contacts were processed successfully\n- PARTIAL_SUCCESS: Some contacts not created\n- NO_CHANGES: No contacts were created\n", "example": "SUCCESS" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CHS_Contact_Schema" } }, "count": { "type": "integer", "description": "Total number of contacts matching the query.", "example": 42 } } } } } } }, "requestBodies": { "CHS_Contact_Bulk_Create_Body": { "description": "A list of contacts to be created.", "required": true, "content": { "application/json": { "schema": { "type": "array", "maxItems": 250, "items": { "$ref": "#/components/schemas/CHS_Contact_Create_Item_Schema" } } } } } }, "parameters": { "CHS_ApplicationId_PathParameter": { "in": "path", "name": "applicationId", "required": true, "description": "Application's ID", "schema": { "type": "integer", "example": 123 } } } } } ```