--- updatedAt: 2026-09-04T07:06:48.000Z agentTools: projectIndex: https://documentation.indigitall.com/llms.txt --- # Get campaign Get campaign information # 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": "es-campaign", "x-displayName": "Email - Campaigns", "description": "Endpoints for manage email campaigns" } ], "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": { "/email/campaign/{id}": { "parameters": [ { "name": "id", "in": "path", "description": "campaign's id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "getCustomValues", "in": "query", "description": "indicate if it is necessary get custom values", "schema": { "type": "boolean" } } ], "get": { "tags": [ "es-campaign" ], "summary": "Get campaign", "description": "Get campaign information", "x-eov-operation-handler": "campaignController", "operationId": "emailGetCampaign", "x-gateway-endpoint": "emailService", "x-gateway-check-permission": { "account-features": [ "EMAIL_ENABLED" ] }, "parameters": [ { "name": "id", "in": "path", "description": "campaign's id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "$ref": "#/components/responses/ES_CampaignResponse" }, "400": { "$ref": "#/components/responses/ES_ParameterMissingOrInvalidResponse" }, "401": { "$ref": "#/components/responses/ES_ErrorAppKeyResponse" }, "403": { "$ref": "#/components/responses/ES_ForbiddenErrorResponse" }, "404": { "$ref": "#/components/responses/ES_CampaignNotFoundResponse" }, "500": { "$ref": "#/components/responses/ES_ServerErrorResponse" } } } } }, "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": { "ES_ErrorSchema": { "required": [ "message", "statusCode" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "Response code" }, "errorCode": { "type": "string", "enum": [ "ES_ATTACHMENT_NOT_FOUND", "ES_SHIPMENT_SCHEDULED", "ES_SHIPMENT_HAVE_VARS", "ES_CAMPAIGN_NOT_FOUND", "ES_CAMPAIGN_NOT_MODIFIABLE", "ES_CAMPAIGN_TEMPLATE_NOT_FOUND", "ES_CAMPAIGN_SENT", "ES_CAMPAIGN_MULTIMEDIA_NOT_FOUND", "ES_CAMPAIGN_HTML_NOT_FOUND", "ES_CAMPAIGN_BLOCK_NOT_FOUND", "ES_CAMPAIGN_BLOCK_COLUMN_NOT_FOUND", "ES_CAMPAIGN_BLOCK_COLUMN_TYPE_ERROR", "ES_COLUMNS_IN_BLOCK_LIMIT", "ES_CONFIGURATION_ALREADY_EXISTS", "ES_CONFIGURATION_NOT_FOUND", "ES_CONFIGURATION_ERROR_MAILJET", "ES_CONFIGURATION_DOMAIN_NOT_FOUND", "ES_CONFIGURATION_DOMAIN_IN_USE", "ES_CONFIGURATION_DOMAIN_EMAIL_NOT_FOUND", "ES_CONFIGURATION_DOMAIN_EMAIL_IN_USE", "ES_CONTACT_NOT_FOUND", "ES_CATEGORY_NOT_FOUND", "ES_CATEGORY_IN_USE", "ES_APPLICATION_NOT_FOUND", "ES_FOOTER_NOT_FOUND", "ES_FOOTER_TITLE_EXISTS", "ES_FOOTER_IN_USE", "ES_SHIPMENT_NOT_FOUND", "ES_CONFLICT", "ES_ACCESS_FORBIDDEN", "ES_AUDIENCE_CJ_NOT_FOUND" ], "description": "* `ES_ATTACHMENT_NOT_FOUND` - Attachment not found\n* `ES_SHIPMENT_SCHEDULED` - Shipment has been scheduled\n* `ES_SHIPMENT_HAVE_VARS` - Sending variables is not allowed in massive mailing.\n* `ES_CAMPAIGN_NOT_FOUND` - Campaign not found\n* `ES_CAMPAIGN_NOT_MODIFIABLE` - Campaign cannot be updated as it belongs to an initialized journey\n* `ES_CAMPAIGN_TEMPLATE_NOT_FOUND` - Campaign template not found\n* `ES_CAMPAIGN_SENT` - Campaign has been send\n* `ES_CAMPAIGN_MULTIMEDIA_NOT_FOUND` - Campaign multimedia not found\n* `ES_CAMPAIGN_HTML_NOT_FOUND` - Campaign html not found\n* `ES_CAMPAIGN_BLOCK_NOT_FOUND` - Campaign block not found\n* `ES_CAMPAIGN_BLOCK_COLUMN_NOT_FOUND` - Campaign block column not found * `ES_CAMPAIGN_BLOCK_COLUMN_TYPE_ERROR` - The parameters of the block column are not correct for this type * `ES_COLUMNS_IN_BLOCK_LIMIT` - The column limit for this block has been exceeded\n* `ES_CONFIGURATION_ALREADY_EXISTS` - Configuration already exists for application * `ES_CONFIGURATION_NOT_FOUND` - Configuration not found * `ES_CONFIGURATION_ERROR_MAILJET` - Error Mailjet Api\n* `ES_CONFIGURATION_DOMAIN_NOT_FOUND` - Configuration domain not found\n* `ES_CONFIGURATION_DOMAIN_IN_USE` - Configuration domain in use\n* `ES_CONFIGURATION_DOMAIN_EMAIL_NOT_FOUND` - Configuration domain email not found\n* `ES_CONFIGURATION_DOMAIN_EMAIL_IN_USE` - Configuration domain email in use\n* `ES_CONTACT_NOT_FOUND` - Contact not found\n* `ES_CATEGORY_NOT_FOUND` - Category not found\n* `ES_CATEGORY_IN_USE` - Category in use\n* `ES_APPLICATION_NOT_FOUND` - Application not found\n* `ES_FOOTER_NOT_FOUND` - Footer not found\n* `ES_FOOTER_IN_USE` - Footer in use\n* `ES_FOOTER_TITLE_EXISTS` - Footer title exists\n* `ES_SHIPMENT_NOT_FOUND` - Shipment not found\n* `ES_CONFLICT` - Unique contraint error\n* `ES_ACCESS_FORBIDDEN` - Access forbidden for user\n* `ES_AUDIENCE_CJ_NOT_FOUND` - The referenced Customer Journey (CJ) audience/segment was not found\n" }, "message": { "type": "string", "description": "Error message" } } }, "ES_ErrorAppKeySchema": { "required": [ "data", "message", "statusCode" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "Response code" }, "message": { "type": "string", "description": "Error message" }, "data": { "type": "object", "properties": {}, "description": "Error data" } } }, "ES_CampaignSchema": { "additionalProperties": false, "required": [ "id", "applicationId", "configurationDomainEmailId", "title", "subject", "bodyType", "replyTo", "createdAt" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Unique identifier for the campaign.", "example": 1001 }, "applicationId": { "type": "integer", "format": "int64", "description": "Identifier for the application associated with the campaign. Can be null if not linked to an application.", "nullable": true, "example": 2001 }, "categoryId": { "type": "integer", "format": "int64", "description": "Identifier for the category under which the campaign is classified. Optional field.", "nullable": true, "example": 3001 }, "configurationDomainEmailId": { "type": "integer", "format": "int64", "description": "Identifier for the email configuration used in the campaign.", "nullable": true, "example": 4001 }, "footerId": { "type": "integer", "format": "int64", "description": "Identifier for the footer template used in the campaign. Optional field.", "nullable": true, "example": 5001 }, "title": { "type": "string", "description": "Title of the campaign, typically used for internal reference.", "example": "Holiday Promo Campaign" }, "subject": { "type": "string", "description": "Subject line of the email campaign sent to recipients.", "example": "Exciting Deals Await!" }, "bodyType": { "type": "string", "enum": [ "html", "block" ], "description": "Format of the campaign body. Can be either `html` or `block`.", "example": "html" }, "replyTo": { "type": "string", "description": "Email address to receive replies from recipients, different from the sender address.", "example": "replies@different-domain.com", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "description": "Date when the campaign was created.", "example": "2023-10-27T10:00:00.000Z" }, "isCustomerService": { "type": "boolean", "description": "Indicates whether the campaign is for customer service purposes.", "example": true }, "previewImage": { "type": "string", "description": "Preview image for the template", "nullable": true }, "numContactsSent": { "type": "integer", "format": "int64", "description": "Total number of contacts to whom the campaign was sent.", "example": 1500 }, "pctContactsClicked": { "type": "number", "description": "Percentage of recipients who clicked on links in the campaign.", "example": 0.35 }, "pctContactsOpened": { "type": "number", "description": "Percentage of recipients who opened the campaign email.", "example": 0.75 }, "customValues": { "type": "array", "description": "List of custom variables associated with the campaign, often used for personalization.", "items": { "type": "string", "example": "promo_code" } }, "lastShipmentType": { "type": "string", "enum": [ null, "INMEDIATE", "SCHEDULED", "SMART_TIME" ], "description": "Type of the last shipment associated with the campaign:\n - `null`: No shipments have been made.\n - `INMEDIATE`: The shipment was sent immediately.\n - `SCHEDULED`: The shipment was scheduled for a later time.\n - `SMART_TIME`: The shipment was optimized for smart delivery times.\n", "example": "INMEDIATE", "nullable": true }, "lastShipmentAt": { "type": "string", "format": "date-time", "description": "Date and time reference for the last shipment.\n- If `lastShipmentType` is SCHEDULED: This is the scheduled date.\n- If `lastShipmentType` is INMEDIATE or SMART_TIME: This is the date/time when the shipment was processed.\n", "example": "2023-10-27T10:00:00.000Z", "nullable": true }, "isTemplate": { "type": "boolean", "description": "Indicates if the campaign is a reusable template.", "example": false, "default": false }, "journeyStatus": { "type": "string", "nullable": true, "enum": [ null, "PENDING", "RUNNING" ], "description": "Current status of a journey associated with the campaign:\n - `PENDING`: Awaiting association with a journey or the journey has not started.\n - `RUNNING`: The journey involving this campaign is currently active.\n", "example": "RUNNING" } } } }, "responses": { "ES_ServerErrorResponse": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ES_ErrorSchema" }, "example": { "statusCode": 500, "errorCode": "ES_SERVER_ERROR", "message": "Server error" } } } }, "ES_ErrorAppKeyResponse": { "description": "App key is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ES_ErrorAppKeySchema" }, "example": { "statusCode": 401, "errorCode": "ES_APP_KEY_IS_NOT_VALID", "message": "App key is not valid" } } } }, "ES_ParameterMissingOrInvalidResponse": { "description": "Parameter is missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ES_ErrorSchema" }, "example": { "statusCode": 400, "errorCode": "ES_PARAMETER_MISSING_OR_INVALID", "message": "Parameter is missing or invalid" } } } }, "ES_ForbiddenErrorResponse": { "description": "Access Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ES_ErrorSchema" }, "example": { "statusCode": 403, "errorCode": "ES_ACCESS_FORBIDDEN", "message": "Access Forbidden" } } } }, "ES_CampaignResponse": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "statusCode", "message", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "description": "Response code", "example": 200 }, "message": { "type": "string", "description": "Response message, usually OK", "example": "OK" }, "data": { "$ref": "#/components/schemas/ES_CampaignSchema" } } } } } }, "ES_CampaignNotFoundResponse": { "description": "Campaign not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ES_ErrorSchema" }, "example": { "statusCode": 404, "errorCode": "ES_CAMPAIGN_NOT_FOUND", "message": "Campaign not found" } } } } } } } ```