{ "item": [ { "id": "39992bc9-12f4-411a-82a3-ab4fd2f77cab", "name": "API Key", "description": { "content": "Create and manage the API keys that authenticate requests to this API.", "type": "text/plain" }, "item": [ { "id": "e14238c3-e095-448e-b415-92782391ef8c", "name": "Find API Keys", "request": { "name": "Find API Keys", "description": { "content": "Returns all API keys associated with your account. Each entry includes the key ID, associated username, allowed operations, traffic type, and creation date, but the full key value is not returned for security reasons. Optionally filter the list by userId to see only keys created by or assigned to a specific user. Use this endpoint to audit which keys exist before creating new ones or revoking old ones. To look up a specific key by its raw string value, use GET /authentication/{value} instead. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "authentication" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "userId", "value": "7621", "description": "Filter by user ID." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "207550a2-3899-4966-b246-47901e650c41", "name": "API Keys retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "7621" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 1,\n \"companyId\": 245,\n \"userId\": 5172,\n \"apiKey\": \"ak_live_abc123...\",\n \"username\": \"api-user\",\n \"trafficType\": 8447,\n \"operations\": [\n \"RCS\",\n \"WEBHOOKS\"\n ],\n \"creationDate\": \"2022-03-10\",\n \"lastUpdateDate\": \"2022-03-10\"\n },\n {\n \"id\": 1,\n \"companyId\": 4912,\n \"userId\": 7625,\n \"apiKey\": \"ak_live_abc123...\",\n \"username\": \"api-user\",\n \"trafficType\": 8960,\n \"operations\": [\n \"CAMPAIGNS\",\n \"INBOX\"\n ],\n \"creationDate\": \"2022-03-10\",\n \"lastUpdateDate\": \"2022-03-10\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d09ba094-34a2-47ee-b22f-642db0417dc5", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "7621" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1aaa7ca-e6b4-49c5-95bd-97aa6e768fc3", "name": "Create an API Key", "request": { "name": "Create an API Key", "description": { "content": "Creates a new API key for your account and returns the full key value in the response. IMPORTANT: The full key value is shown only once in this response. It cannot be retrieved again through any endpoint, so you must copy and store it securely immediately after creation. The key becomes active instantly and can be used to authenticate requests by passing it in the X-API-Key header. You can scope the key to specific operations (e.g. SMS, RCS, WHATSAPP) via the operations field in the request body, allowing you to create least-privilege keys for different integrations. If you lose a key, the only option is to delete it with DELETE /authentication/{id} and create a new one. Returns 400 if the request body is malformed or missing required fields. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"userId\": 4618,\n \"username\": \"marketing-bot\",\n \"trafficType\": 0,\n \"operations\": [\n \"SMS\",\n \"RCS\",\n \"WHATSAPP\",\n \"CONTACTS\",\n \"MESSAGES\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23433464-6055-407b-84e1-b7d92aa53fd7", "name": "API Key created successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": 4618,\n \"username\": \"marketing-bot\",\n \"trafficType\": 0,\n \"operations\": [\n \"SMS\",\n \"RCS\",\n \"WHATSAPP\",\n \"CONTACTS\",\n \"MESSAGES\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"companyId\": 100,\n \"apiKey\": \"ak_live_abc123def456\",\n \"username\": \"api-user\",\n \"trafficType\": 0,\n \"operations\": [\n \"SMS\",\n \"RCS\",\n \"WHATSAPP\"\n ],\n \"creationDate\": \"2025-03-10 14:30:00.000+0100\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387b0ca4-386d-4e64-81d8-948e5237cf33", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": 4618,\n \"username\": \"marketing-bot\",\n \"trafficType\": 0,\n \"operations\": [\n \"SMS\",\n \"RCS\",\n \"WHATSAPP\",\n \"CONTACTS\",\n \"MESSAGES\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "254e55c6-17a3-4f1a-9947-a25d44f6e20f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": 4618,\n \"username\": \"marketing-bot\",\n \"trafficType\": 0,\n \"operations\": [\n \"SMS\",\n \"RCS\",\n \"WHATSAPP\",\n \"CONTACTS\",\n \"MESSAGES\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c407f5a6-31b7-46f2-8bc1-7cead510452c", "name": "Delete an API Key", "request": { "name": "Delete an API Key", "description": { "content": "Permanently revokes and deletes an API key. Revocation takes effect immediately: any subsequent API request that uses the deleted key in the X-API-Key header will receive a 401 Unauthorized response. This action cannot be undone. If you delete a key by mistake, you must create a new one with POST /authentication and update all clients that were using the old key. Before deleting, ensure no active integrations or scheduled jobs depend on this key to avoid service interruptions. Returns 204 on success with no response body. Returns 404 if no key with the given ID exists or it does not belong to your account. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "authentication", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the API Key to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1efc3a67-f05d-4d7d-9f55-af29e616dc28", "name": "API Key deleted successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the API Key to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cea6290-4b25-48d0-ac11-0591509faf82", "name": "API Key not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the API Key to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1be2f08a-86a9-4c4e-afb8-128f9e5feefe", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the API Key to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0600c468-b597-4d41-a073-33d19c3832db", "name": "Find API Key by value", "request": { "name": "Find API Key by value", "description": { "content": "Looks up an API key by its raw string value and returns its metadata (ID, company, username, allowed operations, traffic type, and creation date). This is useful to verify that a key you have stored is still valid and to check which operations it is authorized for. The value path parameter must be the complete API key string exactly as it was returned when the key was created. Returns 404 if no key matches the provided value, which could mean the key was deleted or never existed. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "authentication", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "value", "description": "(Required) The API Key string value to look up." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0e927a20-015d-48d8-921d-280cd0b579f0", "name": "API Key retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "value", "description": "(Required) The API Key string value to look up." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"companyId\": 6641,\n \"userId\": 3762,\n \"apiKey\": \"ak_live_abc123...\",\n \"username\": \"api-user\",\n \"trafficType\": 1419,\n \"operations\": [\n \"SOCIALS\",\n \"SOCIALS\"\n ],\n \"creationDate\": \"2022-03-10\",\n \"lastUpdateDate\": \"2022-03-10\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e347db49-3a81-49f7-a31b-86e2a1bbe05e", "name": "API Key not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "value", "description": "(Required) The API Key string value to look up." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d317387e-6b60-4076-bf2f-99270abc7e06", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "authentication", ":value" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "value", "description": "(Required) The API Key string value to look up." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "71b8d983-f162-473b-8a93-5a0ad32d4310", "name": "Campaigns", "description": { "content": "Create, schedule, and monitor bulk messaging campaigns.", "type": "text/plain" }, "item": [ { "id": "b05d26b6-9b39-48f4-81ce-a84942dd9a3a", "name": "List campaigns", "request": { "name": "List campaigns", "description": { "content": "Returns a paginated list of campaigns for your account. Use isDraft=true to see unpublished drafts that have not yet been confirmed, or isDraft=false to exclude them. Use isProgrammed=true to retrieve only campaigns that have been confirmed and are scheduled for future delivery. Filter by channel with sendingMode set to SMS, RCS, or WHATSAPP (comma-separated values are accepted to match multiple channels at once). The search parameter performs a case-insensitive match against campaign name and description fields. Use startDate and endDate (yyyy-MM-dd format) together to restrict results to campaigns created or scheduled within that date window. Results are paginated: page is 0-based and limit controls the page size. Use direction=ASC or direction=DESC to control sort order. The readyToSend filter lets you find campaigns that have been fully configured but not yet confirmed (true) or campaigns still being drafted (false). This endpoint is useful for building campaign dashboards and monitoring the overall state of your messaging operations. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "channel", "value": "string", "description": "Channel filter" }, { "disabled": false, "key": "channelId", "value": "string", "description": "Channel ID filter" }, { "disabled": false, "key": "direction", "value": "string", "description": "Sort direction: ASC or DESC" }, { "disabled": false, "key": "endDate", "value": "string", "description": "End date filter (yyyy-MM-dd)" }, { "disabled": false, "key": "isDraft", "value": "true", "description": "Filter by draft status" }, { "disabled": false, "key": "isProgrammed", "value": "true", "description": "Filter by scheduled status" }, { "disabled": false, "key": "limit", "value": "7225", "description": "Page size" }, { "disabled": false, "key": "page", "value": "7225", "description": "Page number (0-based)" }, { "disabled": false, "key": "readyToSend", "value": "true", "description": "Filter by ready-to-send state" }, { "disabled": false, "key": "search", "value": "string", "description": "Search by name or description" }, { "disabled": false, "key": "sendingMode", "value": "string", "description": "Comma-separated sending modes (RCS, SMS, WHATSAPP, ...)" }, { "disabled": false, "key": "startDate", "value": "string", "description": "Start date filter (yyyy-MM-dd)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cecd13ab-d60d-4324-bb25-304a2d995395", "name": "Campaigns retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "string" }, { "key": "channelId", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "endDate", "value": "string" }, { "key": "isDraft", "value": "true" }, { "key": "isProgrammed", "value": "true" }, { "key": "limit", "value": "7225" }, { "key": "page", "value": "7225" }, { "key": "readyToSend", "value": "true" }, { "key": "search", "value": "string" }, { "key": "sendingMode", "value": "string" }, { "key": "startDate", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a404096-a4e0-49fd-8b72-6bc8247513fc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "string" }, { "key": "channelId", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "endDate", "value": "string" }, { "key": "isDraft", "value": "true" }, { "key": "isProgrammed", "value": "true" }, { "key": "limit", "value": "7225" }, { "key": "page", "value": "7225" }, { "key": "readyToSend", "value": "true" }, { "key": "search", "value": "string" }, { "key": "sendingMode", "value": "string" }, { "key": "startDate", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a01551b7-9df6-418a-9e97-b5dfef9f657d", "name": "Create a campaign", "request": { "name": "Create a campaign", "description": { "content": "Creates a new bulk messaging campaign. The typical lifecycle is: (1) Create the campaign with readyToSend=false to save it as a draft. (2) Optionally update the campaign with PUT /campaigns/{id} to adjust its configuration. (3) Call POST /campaigns/{id}/calculateGoal to compute the recipient count and estimated cost. (4) Review the price with GET /campaigns/{id}/price. (5) Set readyToSend=true via PUT /campaigns/{id} when the configuration is final. (6) Confirm and dispatch the campaign with PUT /campaigns/{id}/confirm. The channel is determined by the sendingMode field. Valid values are: SMS (plain text messages), RCS (rich card messages via an RCS agent), WHATSAPP (pre-approved WhatsApp templates), and combined modes like RCS_SMS, WHATSAPP_SMS, WHATSAPP_RCS, WHATSAPP_RCS_SMS which provide automatic fallback across channels. For SMS campaigns, you must provide smsSender (the alphanumeric sender ID or phone number) and smsBody (the message text, which supports {{placeholder}} syntax for personalization using contact fields). For RCS campaigns, you must provide rcsAgentId and rcsTemplateId. For WhatsApp campaigns, you must provide whatsappPhoneNumberId and whatsappTemplateId. Recipients are specified either by contactListIds (an array of contact list IDs, destinationType=1) or by destinations (an array of phone numbers in E.164 format, destinationType=2). You can set a scheduledDate in the future (format: yyyy-MM-dd HH:mm:ss.SSSZ) to schedule the campaign for later delivery instead of immediate dispatch upon confirmation. Returns 400 if required fields are missing or if sendingMode is not a valid value. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Spring Promo\",\n \"sendingMode\": \"SMS\",\n \"smsSender\": \"MYCOMPANY\",\n \"smsBody\": \"Hi {{firstName}}, your exclusive 20% discount is ready!\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"readyToSend\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bab985f1-17a3-4094-9ad3-08f1e21130ed", "name": "Campaign created successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spring Promo\",\n \"sendingMode\": \"SMS\",\n \"smsSender\": \"MYCOMPANY\",\n \"smsBody\": \"Hi {{firstName}}, your exclusive 20% discount is ready!\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"readyToSend\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1002,\n \"name\": \"Spring Promo\",\n \"status\": 0,\n \"sendingMode\": \"SMS\",\n \"smsSender\": \"MYCOMPANY\",\n \"smsBody\": \"Hi {{firstName}}, your discount is ready!\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"readyToSend\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ce84891-f2f4-44a7-ab5a-0b289fb86de4", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spring Promo\",\n \"sendingMode\": \"SMS\",\n \"smsSender\": \"MYCOMPANY\",\n \"smsBody\": \"Hi {{firstName}}, your exclusive 20% discount is ready!\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"readyToSend\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b893950f-d2d6-4856-a8fd-f2a71ed07ccb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Spring Promo\",\n \"sendingMode\": \"SMS\",\n \"smsSender\": \"MYCOMPANY\",\n \"smsBody\": \"Hi {{firstName}}, your exclusive 20% discount is ready!\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"readyToSend\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "876a58e0-4d55-45be-b48f-4c519f6f29f2", "name": "Get campaign statistics", "request": { "name": "Get campaign statistics", "description": { "content": "Returns aggregated delivery statistics for campaigns in a given date range. Results are grouped by the aggregateOn time bucket. Valid values for aggregateOn are: hour, day, week, and month. You must provide both startDate and endDate in yyyy-MM-dd format to define the reporting window. Filter by sendingMode (SMS, RCS, WHATSAPP) to see statistics for a specific channel, or omit it to get combined stats across all channels. Set isDraft=false to exclude draft campaigns that were never sent, so that only confirmed and dispatched campaigns contribute to the statistics. Each time bucket in the response contains counts for total messages sent, delivered, failed, and other delivery metrics. Results are paginated: use page (0-based) and limit to control pagination, and direction=ASC or direction=DESC to sort the time buckets chronologically or in reverse. This endpoint is useful for building analytics dashboards, generating periodic delivery reports, and monitoring campaign performance trends over time. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "aggregateOn", "value": "string", "description": "(Required) Time aggregation bucket: day, hour, week, month" }, { "disabled": false, "key": "direction", "value": "string", "description": "Sort direction: ASC or DESC" }, { "disabled": false, "key": "endDate", "value": "string", "description": "(Required) End date (yyyy-MM-dd)" }, { "disabled": false, "key": "isDraft", "value": "true", "description": "Filter by draft status" }, { "disabled": false, "key": "limit", "value": "7225", "description": "Page size" }, { "disabled": false, "key": "page", "value": "7225", "description": "Page number" }, { "disabled": false, "key": "sendingMode", "value": "string", "description": "Filter by sending mode" }, { "disabled": false, "key": "startDate", "value": "string", "description": "(Required) Start date (yyyy-MM-dd)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a7759790-b2d8-4194-b6c9-b81b22c22b87", "name": "Statistics retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "aggregateOn", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "endDate", "value": "string" }, { "key": "isDraft", "value": "true" }, { "key": "limit", "value": "7225" }, { "key": "page", "value": "7225" }, { "key": "sendingMode", "value": "string" }, { "key": "startDate", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c88b552-d38b-4a3e-8163-5d532a1e7187", "name": "Missing or invalid required parameters", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "aggregateOn", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "endDate", "value": "string" }, { "key": "isDraft", "value": "true" }, { "key": "limit", "value": "7225" }, { "key": "page", "value": "7225" }, { "key": "sendingMode", "value": "string" }, { "key": "startDate", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d670ecd4-2a06-4e2f-a3d7-11e3339a4b2f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "aggregateOn", "value": "string" }, { "key": "direction", "value": "string" }, { "key": "endDate", "value": "string" }, { "key": "isDraft", "value": "true" }, { "key": "limit", "value": "7225" }, { "key": "page", "value": "7225" }, { "key": "sendingMode", "value": "string" }, { "key": "startDate", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "278a650f-5fee-4df7-9829-0f46ec56be52", "name": "Update a campaign", "request": { "name": "Update a campaign", "description": { "content": "Updates the details of an existing campaign. Only campaigns that are still in draft status (status=0) or scheduled status (status=1) can be modified. Campaigns that are currently being sent (status=2), completed (status=3), or failed (status=4) cannot be updated. You can use this endpoint to change the campaign name, description, message body, sender, recipient contact lists, sending mode, scheduled date, or the readyToSend flag. A common workflow is to create a campaign as a draft (readyToSend=false), iterate on its configuration using this endpoint, then set readyToSend=true when the campaign is finalized, and finally call PUT /campaigns/{id}/confirm to dispatch it. After updating recipient lists or message content, call POST /campaigns/{id}/calculateGoal to refresh the recipient count and cost estimate. Returns 400 if the request body is invalid or if the campaign is in a non-editable state. Returns 404 if no campaign exists with the given ID under your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"destinationType\": 1,\n \"destinations\": [\n \"+393331234567\",\n \"+393339876543\"\n ],\n \"smsSender\": \"MYCOMPANY\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"sendingMode\": \"SMS\",\n \"scheduledDate\": \"2022-03-10\",\n \"name\": \"Summer Promo\",\n \"description\": \"25% off all Summer 2025 collection — VIP segment only\",\n \"rcsAgentId\": \"ag-2_ci5xnlho_agent\",\n \"rcsTemplateId\": 1804,\n \"rcsTemplateType\": \"CARD\",\n \"smsBody\": \"Hi {{firstName}}, your 25% discount on the new Summer collection is ready! Code: {{code}}\",\n \"placeholderFields\": \"{\\\"code\\\":\\\"SUMMER25\\\"}\",\n \"readyToSend\": true,\n \"whatsappPhoneNumberId\": 61,\n \"whatsappTemplateId\": 169\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d8af601d-0b49-42b1-8598-856b085bb999", "name": "Campaign updated successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"destinationType\": 1,\n \"destinations\": [\n \"+393331234567\",\n \"+393339876543\"\n ],\n \"smsSender\": \"MYCOMPANY\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"sendingMode\": \"SMS\",\n \"scheduledDate\": \"2022-03-10\",\n \"name\": \"Summer Promo\",\n \"description\": \"25% off all Summer 2025 collection — VIP segment only\",\n \"rcsAgentId\": \"ag-2_ci5xnlho_agent\",\n \"rcsTemplateId\": 1804,\n \"rcsTemplateType\": \"CARD\",\n \"smsBody\": \"Hi {{firstName}}, your 25% discount on the new Summer collection is ready! Code: {{code}}\",\n \"placeholderFields\": \"{\\\"code\\\":\\\"SUMMER25\\\"}\",\n \"readyToSend\": true,\n \"whatsappPhoneNumberId\": 61,\n \"whatsappTemplateId\": 169\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1001,\n \"userId\": 7177,\n \"companyId\": 5532,\n \"creationDate\": \"2022-03-10\",\n \"scheduledDate\": \"2022-03-10\",\n \"lastUpdateDate\": \"2022-03-10\",\n \"startDate\": \"2022-03-10\",\n \"endDate\": \"2022-03-10\",\n \"name\": \"Spring Promo\",\n \"description\": \"string\",\n \"status\": \"ARCHIVED\",\n \"sendingMode\": \"SMS\",\n \"contactListIds\": [\n 7336,\n 5731\n ],\n \"rcsAgentId\": \"string\",\n \"rcsTemplateBody\": {\n \"empty\": true,\n \"valueNode\": false,\n \"containerNode\": false,\n \"missingNode\": false,\n \"array\": false,\n \"object\": false,\n \"nodeType\": \"OBJECT\",\n \"pojo\": false,\n \"number\": false,\n \"integralNumber\": false,\n \"floatingPointNumber\": false,\n \"short\": true,\n \"int\": true,\n \"long\": false,\n \"float\": true,\n \"double\": false,\n \"bigDecimal\": false,\n \"bigInteger\": true,\n \"textual\": true,\n \"boolean\": false,\n \"null\": false,\n \"binary\": true\n },\n \"rcsTemplateId\": 5011,\n \"rcsTemplateType\": \"string\",\n \"totalDestinations\": 3339,\n \"totalPrice\": 1986,\n \"smsSender\": \"string\",\n \"smsBody\": \"string\",\n \"placeholderFields\": \"string\",\n \"totalSuccess\": 916,\n \"totalFailed\": 2479,\n \"totalSent\": 7344,\n \"totalRead\": 7001,\n \"totalFallback\": 1223,\n \"rcsSent\": 3814,\n \"rcsPending\": 4909,\n \"rcsSuccess\": 5932,\n \"rcsFailed\": 7618,\n \"rcsRead\": 9953,\n \"smsSent\": 3647,\n \"smsPending\": 4437,\n \"smsSuccess\": 1992,\n \"smsFailed\": 889,\n \"smsFallback\": 2465,\n \"waSent\": 7431,\n \"waPending\": 851,\n \"waSuccess\": 4825,\n \"waFailed\": 5444,\n \"waFallback\": 3477,\n \"waRead\": 5344,\n \"destinationType\": 3380,\n \"destinations\": [\n \"string\",\n \"string\"\n ],\n \"isUpdatable\": true,\n \"maxUpdateTime\": \"2022-03-10\",\n \"readyToSend\": false,\n \"whatsappPhoneNumberId\": 7083,\n \"whatsappTemplateId\": 8929,\n \"whatsappMessageBody\": {\n \"empty\": false,\n \"valueNode\": false,\n \"containerNode\": false,\n \"missingNode\": false,\n \"array\": true,\n \"object\": true,\n \"nodeType\": \"NULL\",\n \"pojo\": false,\n \"number\": true,\n \"integralNumber\": true,\n \"floatingPointNumber\": false,\n \"short\": true,\n \"int\": false,\n \"long\": true,\n \"float\": true,\n \"double\": true,\n \"bigDecimal\": true,\n \"bigInteger\": false,\n \"textual\": false,\n \"boolean\": false,\n \"null\": false,\n \"binary\": true\n },\n \"numOfDistinctContact\": 8575,\n \"whatsappExceedingDestinationUnitPrice\": 6567,\n \"whatsappExceedingDestinationNum\": 917\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ecd6f47-a3fa-452a-b642-b2ef7f3abd09", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"destinationType\": 1,\n \"destinations\": [\n \"+393331234567\",\n \"+393339876543\"\n ],\n \"smsSender\": \"MYCOMPANY\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"sendingMode\": \"SMS\",\n \"scheduledDate\": \"2022-03-10\",\n \"name\": \"Summer Promo\",\n \"description\": \"25% off all Summer 2025 collection — VIP segment only\",\n \"rcsAgentId\": \"ag-2_ci5xnlho_agent\",\n \"rcsTemplateId\": 1804,\n \"rcsTemplateType\": \"CARD\",\n \"smsBody\": \"Hi {{firstName}}, your 25% discount on the new Summer collection is ready! Code: {{code}}\",\n \"placeholderFields\": \"{\\\"code\\\":\\\"SUMMER25\\\"}\",\n \"readyToSend\": true,\n \"whatsappPhoneNumberId\": 61,\n \"whatsappTemplateId\": 169\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edd019a8-f6ad-48b2-83a1-d553491f1df8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"destinationType\": 1,\n \"destinations\": [\n \"+393331234567\",\n \"+393339876543\"\n ],\n \"smsSender\": \"MYCOMPANY\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"sendingMode\": \"SMS\",\n \"scheduledDate\": \"2022-03-10\",\n \"name\": \"Summer Promo\",\n \"description\": \"25% off all Summer 2025 collection — VIP segment only\",\n \"rcsAgentId\": \"ag-2_ci5xnlho_agent\",\n \"rcsTemplateId\": 1804,\n \"rcsTemplateType\": \"CARD\",\n \"smsBody\": \"Hi {{firstName}}, your 25% discount on the new Summer collection is ready! Code: {{code}}\",\n \"placeholderFields\": \"{\\\"code\\\":\\\"SUMMER25\\\"}\",\n \"readyToSend\": true,\n \"whatsappPhoneNumberId\": 61,\n \"whatsappTemplateId\": 169\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "875f604e-29eb-4f19-8076-e63f64a35096", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"destinationType\": 1,\n \"destinations\": [\n \"+393331234567\",\n \"+393339876543\"\n ],\n \"smsSender\": \"MYCOMPANY\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"sendingMode\": \"SMS\",\n \"scheduledDate\": \"2022-03-10\",\n \"name\": \"Summer Promo\",\n \"description\": \"25% off all Summer 2025 collection — VIP segment only\",\n \"rcsAgentId\": \"ag-2_ci5xnlho_agent\",\n \"rcsTemplateId\": 1804,\n \"rcsTemplateType\": \"CARD\",\n \"smsBody\": \"Hi {{firstName}}, your 25% discount on the new Summer collection is ready! Code: {{code}}\",\n \"placeholderFields\": \"{\\\"code\\\":\\\"SUMMER25\\\"}\",\n \"readyToSend\": true,\n \"whatsappPhoneNumberId\": 61,\n \"whatsappTemplateId\": 169\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfe09bc2-6be7-4db1-89ed-eb1e4df34044", "name": "Get a campaign", "request": { "name": "Get a campaign", "description": { "content": "Returns the full details of a single campaign identified by its numeric ID. The response includes the campaign status, sending channel (sendingMode), recipient count (totalDestinations), delivery results (totalSuccess, totalFailed), message content (smsBody for SMS, template IDs for RCS or WhatsApp), the list of associated contactListIds, and any scheduled date. Use this endpoint to inspect a campaign at any stage of its lifecycle: while drafting, after confirmation, during sending, or after completion. The status field is numeric: 0 means draft, 1 means ready/scheduled, 2 means sending in progress, 3 means completed, and 4 means failed. Returns 404 if no campaign exists with the given ID under your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "718e4aef-d960-4a7d-850a-32095208255e", "name": "Campaign retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1001,\n \"name\": \"Spring Promo\",\n \"status\": 3,\n \"sendingMode\": \"SMS\",\n \"smsSender\": \"MYCOMPANY\",\n \"smsBody\": \"Hi! Your 20% discount is ready.\",\n \"contactListIds\": [\n 101,\n 102\n ],\n \"totalDestinations\": 500,\n \"totalSuccess\": 485,\n \"totalFailed\": 15,\n \"readyToSend\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32f6384d-dd65-4380-9235-c1c615021b80", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3325cc4a-09ce-4d32-836f-c7d52ed622f3", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aa6ac87-f653-4f94-a872-bf4af9c9ef2a", "name": "Delete a campaign", "request": { "name": "Delete a campaign", "description": { "content": "Permanently deletes a campaign. Only campaigns that are still in draft status (status=0) or scheduled status (status=1) can be deleted. Campaigns that are currently being sent (status=2), already completed (status=3), or in a failed state (status=4) cannot be deleted because their delivery records must be preserved for reporting. If you need to stop a scheduled campaign before it sends, delete it before the scheduledDate is reached. This operation is irreversible: once deleted, the campaign and its configuration are permanently removed and cannot be recovered. Returns 204 No Content on successful deletion. Returns 404 if no campaign exists with the given ID under your account, or if the campaign is in a non-deletable state. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "022976d9-52f3-487b-96bf-8952cad67500", "name": "Campaign deleted successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a711664b-08c0-46e8-af5c-56c9f889f720", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3e85dd9-4928-44c8-87e7-3b08c1066198", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a132c82c-4eb3-49e1-98c7-37dfecb31f55", "name": "Recalculate campaign cost", "request": { "name": "Recalculate campaign cost", "description": { "content": "Recalculates the estimated recipient count and total cost for the campaign based on its current configuration and the associated contact lists. You should call this endpoint every time you modify the campaign recipients (contactListIds or destinations) or change the sendingMode, because different channels have different per-message pricing and the recipient count may change if lists are added or removed. The response includes the updated campaign object with recalculated totalDestinations and cost fields. This is a prerequisite step before confirming a campaign: if you skip it, the confirm endpoint may reject the campaign because the cost has not been computed. After calling this, use GET /campaigns/{id}/price to retrieve just the price breakdown. Returns 404 if no campaign exists with the given ID under your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "calculateGoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "db4f6c21-a9b0-4817-ba51-5f37589d6a7e", "name": "Goal recalculated successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "calculateGoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1001,\n \"userId\": 7177,\n \"companyId\": 5532,\n \"creationDate\": \"2022-03-10\",\n \"scheduledDate\": \"2022-03-10\",\n \"lastUpdateDate\": \"2022-03-10\",\n \"startDate\": \"2022-03-10\",\n \"endDate\": \"2022-03-10\",\n \"name\": \"Spring Promo\",\n \"description\": \"string\",\n \"status\": \"ARCHIVED\",\n \"sendingMode\": \"SMS\",\n \"contactListIds\": [\n 7336,\n 5731\n ],\n \"rcsAgentId\": \"string\",\n \"rcsTemplateBody\": {\n \"empty\": true,\n \"valueNode\": false,\n \"containerNode\": false,\n \"missingNode\": false,\n \"array\": false,\n \"object\": false,\n \"nodeType\": \"OBJECT\",\n \"pojo\": false,\n \"number\": false,\n \"integralNumber\": false,\n \"floatingPointNumber\": false,\n \"short\": true,\n \"int\": true,\n \"long\": false,\n \"float\": true,\n \"double\": false,\n \"bigDecimal\": false,\n \"bigInteger\": true,\n \"textual\": true,\n \"boolean\": false,\n \"null\": false,\n \"binary\": true\n },\n \"rcsTemplateId\": 5011,\n \"rcsTemplateType\": \"string\",\n \"totalDestinations\": 3339,\n \"totalPrice\": 1986,\n \"smsSender\": \"string\",\n \"smsBody\": \"string\",\n \"placeholderFields\": \"string\",\n \"totalSuccess\": 916,\n \"totalFailed\": 2479,\n \"totalSent\": 7344,\n \"totalRead\": 7001,\n \"totalFallback\": 1223,\n \"rcsSent\": 3814,\n \"rcsPending\": 4909,\n \"rcsSuccess\": 5932,\n \"rcsFailed\": 7618,\n \"rcsRead\": 9953,\n \"smsSent\": 3647,\n \"smsPending\": 4437,\n \"smsSuccess\": 1992,\n \"smsFailed\": 889,\n \"smsFallback\": 2465,\n \"waSent\": 7431,\n \"waPending\": 851,\n \"waSuccess\": 4825,\n \"waFailed\": 5444,\n \"waFallback\": 3477,\n \"waRead\": 5344,\n \"destinationType\": 3380,\n \"destinations\": [\n \"string\",\n \"string\"\n ],\n \"isUpdatable\": true,\n \"maxUpdateTime\": \"2022-03-10\",\n \"readyToSend\": false,\n \"whatsappPhoneNumberId\": 7083,\n \"whatsappTemplateId\": 8929,\n \"whatsappMessageBody\": {\n \"empty\": false,\n \"valueNode\": false,\n \"containerNode\": false,\n \"missingNode\": false,\n \"array\": true,\n \"object\": true,\n \"nodeType\": \"NULL\",\n \"pojo\": false,\n \"number\": true,\n \"integralNumber\": true,\n \"floatingPointNumber\": false,\n \"short\": true,\n \"int\": false,\n \"long\": true,\n \"float\": true,\n \"double\": true,\n \"bigDecimal\": true,\n \"bigInteger\": false,\n \"textual\": false,\n \"boolean\": false,\n \"null\": false,\n \"binary\": true\n },\n \"numOfDistinctContact\": 8575,\n \"whatsappExceedingDestinationUnitPrice\": 6567,\n \"whatsappExceedingDestinationNum\": 917\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c14b2f7-a542-4da4-8fea-d18e292a417a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "calculateGoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d9bcf69-7ed8-4d33-8079-4b47919d7c5c", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "calculateGoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2403db95-e0a8-4fd1-9588-02a2e87e14db", "name": "Confirm / schedule a campaign", "request": { "name": "Confirm / schedule a campaign", "description": { "content": "Validates and confirms the campaign for sending. This is the final and irreversible step in the campaign lifecycle: once confirmed, messages will be dispatched to all recipients (either immediately or at the scheduledDate if one was set). Before calling this endpoint, ensure that: (1) The campaign has a valid sendingMode and the corresponding channel-specific fields are populated (smsSender/smsBody for SMS, rcsAgentId/rcsTemplateId for RCS, whatsappPhoneNumberId/whatsappTemplateId for WhatsApp). (2) At least one recipient source is configured (contactListIds or destinations). (3) The campaign cost has been calculated by calling POST /campaigns/{id}/calculateGoal. (4) Your account has sufficient credit to cover the total cost. (5) The readyToSend flag is set to true on the campaign. Returns 202 Accepted when the campaign is successfully confirmed and queued for delivery. Returns 400 if any validation fails: missing required fields, insufficient credit balance, readyToSend is false, or the cost has not been calculated. Returns 404 if no campaign exists with the given ID under your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "040596ce-cfae-48d5-9959-5dc8c028a7d0", "name": "Campaign confirmed and scheduled", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2290bc60-8fa8-4af9-b861-14dd14bf36b2", "name": "Validation error or insufficient credit", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67b2b58d-7780-439d-ab42-3a3bdb3f2182", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7108205-481f-456a-8b3b-53bece8699f5", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "652d224f-cb0a-473a-a20c-e0fa0ebd7614", "name": "Get campaign total price", "request": { "name": "Get campaign total price", "description": { "content": "Returns the estimated total price for the campaign based on its current configuration. The price depends on the sendingMode (channel), the number of recipients in the associated contact lists, and the per-message rate for your account. You should call POST /campaigns/{id}/calculateGoal before using this endpoint to ensure the cost estimate is up to date. If the cost has not been calculated yet, the returned price may be zero or stale. Use this endpoint to display a cost preview to users before they confirm and dispatch the campaign with PUT /campaigns/{id}/confirm. Returns 404 if no campaign exists with the given ID under your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5f51de40-c184-4c59-82db-0452da2b05e2", "name": "Price retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1001,\n \"userId\": 7177,\n \"companyId\": 5532,\n \"creationDate\": \"2022-03-10\",\n \"scheduledDate\": \"2022-03-10\",\n \"lastUpdateDate\": \"2022-03-10\",\n \"startDate\": \"2022-03-10\",\n \"endDate\": \"2022-03-10\",\n \"name\": \"Spring Promo\",\n \"description\": \"string\",\n \"status\": \"ARCHIVED\",\n \"sendingMode\": \"SMS\",\n \"contactListIds\": [\n 7336,\n 5731\n ],\n \"rcsAgentId\": \"string\",\n \"rcsTemplateBody\": {\n \"empty\": true,\n \"valueNode\": false,\n \"containerNode\": false,\n \"missingNode\": false,\n \"array\": false,\n \"object\": false,\n \"nodeType\": \"OBJECT\",\n \"pojo\": false,\n \"number\": false,\n \"integralNumber\": false,\n \"floatingPointNumber\": false,\n \"short\": true,\n \"int\": true,\n \"long\": false,\n \"float\": true,\n \"double\": false,\n \"bigDecimal\": false,\n \"bigInteger\": true,\n \"textual\": true,\n \"boolean\": false,\n \"null\": false,\n \"binary\": true\n },\n \"rcsTemplateId\": 5011,\n \"rcsTemplateType\": \"string\",\n \"totalDestinations\": 3339,\n \"totalPrice\": 1986,\n \"smsSender\": \"string\",\n \"smsBody\": \"string\",\n \"placeholderFields\": \"string\",\n \"totalSuccess\": 916,\n \"totalFailed\": 2479,\n \"totalSent\": 7344,\n \"totalRead\": 7001,\n \"totalFallback\": 1223,\n \"rcsSent\": 3814,\n \"rcsPending\": 4909,\n \"rcsSuccess\": 5932,\n \"rcsFailed\": 7618,\n \"rcsRead\": 9953,\n \"smsSent\": 3647,\n \"smsPending\": 4437,\n \"smsSuccess\": 1992,\n \"smsFailed\": 889,\n \"smsFallback\": 2465,\n \"waSent\": 7431,\n \"waPending\": 851,\n \"waSuccess\": 4825,\n \"waFailed\": 5444,\n \"waFallback\": 3477,\n \"waRead\": 5344,\n \"destinationType\": 3380,\n \"destinations\": [\n \"string\",\n \"string\"\n ],\n \"isUpdatable\": true,\n \"maxUpdateTime\": \"2022-03-10\",\n \"readyToSend\": false,\n \"whatsappPhoneNumberId\": 7083,\n \"whatsappTemplateId\": 8929,\n \"whatsappMessageBody\": {\n \"empty\": false,\n \"valueNode\": false,\n \"containerNode\": false,\n \"missingNode\": false,\n \"array\": true,\n \"object\": true,\n \"nodeType\": \"NULL\",\n \"pojo\": false,\n \"number\": true,\n \"integralNumber\": true,\n \"floatingPointNumber\": false,\n \"short\": true,\n \"int\": false,\n \"long\": true,\n \"float\": true,\n \"double\": true,\n \"bigDecimal\": true,\n \"bigInteger\": false,\n \"textual\": false,\n \"boolean\": false,\n \"null\": false,\n \"binary\": true\n },\n \"numOfDistinctContact\": 8575,\n \"whatsappExceedingDestinationUnitPrice\": 6567,\n \"whatsappExceedingDestinationNum\": 917\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e2e8f20-562c-4222-8078-86eb09a475e2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8c9d625-4805-4e03-b3bc-b1384e097a5d", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "campaigns", ":id", "price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "727db286-055e-4394-ba93-3b01c51e1cbf", "name": "Contact", "description": { "content": "Manage individual contacts in your address book.", "type": "text/plain" }, "item": [ { "id": "baebdb2d-e5e5-424c-b394-ad0fcad5b139", "name": "Find contacts", "request": { "name": "Find contacts", "description": { "content": "Searches and retrieves contacts with flexible filtering and pagination. This endpoint has two distinct behaviors depending on the listIds parameter. When listIds is provided (comma-separated contact list IDs), it returns the distinct set of contacts that belong to those lists, with optional additional filters applied on top. When listIds is omitted, it searches across all contacts in your account matching the provided filters. Use notListIds to exclude contacts that belong to specific lists, which is useful for finding contacts not yet assigned to a target list. The search parameter performs a case-insensitive match against the contact name and other text fields. You can filter by gender, isValid (whether the phone number has been validated), communicationSupported (e.g., SMS, RCS, WHATSAPP), isTest (to find or exclude test contacts), phoneNumber (exact match), and email (exact match). Results are paginated: page is 0-based, limit defaults to 10 (maximum 1000). Use sortBy to choose the sort field (defaults to fullName) and sortOrder for asc or desc. The sortPriorityListId parameter causes contacts belonging to that specific list to appear first in the results, which is useful when displaying contacts with a primary list highlighted. To retrieve contacts for a specific list with a cleaner API, consider using GET /contacts/list/{listId}/contacts instead. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "communicationSupported", "value": "string", "description": "Filter by supported communication channel." }, { "disabled": false, "key": "email", "value": "string", "description": "Filter by email." }, { "disabled": false, "key": "gender", "value": "string", "description": "Filter by gender." }, { "disabled": false, "key": "id", "value": "7621", "description": "Contact ID to filter by." }, { "disabled": false, "key": "isTest", "value": "true", "description": "Filter by test flag." }, { "disabled": false, "key": "isValid", "value": "true", "description": "Filter by validity flag." }, { "disabled": false, "key": "lastCampaignType", "value": "string", "description": "Filter by last campaign type." }, { "disabled": false, "key": "lastContactType", "value": "string", "description": "Filter by last contact type." }, { "disabled": false, "key": "limit", "value": "974", "description": "Maximum number of results per page. Defaults to 10." }, { "disabled": false, "key": "listIds", "value": "string", "description": "Comma-separated list of contact list IDs to filter contacts by inclusion." }, { "disabled": false, "key": "notListIds", "value": "string", "description": "Comma-separated list of contact list IDs to filter contacts by exclusion." }, { "disabled": false, "key": "page", "value": "7225", "description": "Page number (0-based). Defaults to 0." }, { "disabled": false, "key": "phoneNumber", "value": "string", "description": "Filter by phone number." }, { "disabled": false, "key": "search", "value": "string", "description": "Search string matched against name and other fields." }, { "disabled": false, "key": "sortBy", "value": "string", "description": "Field to sort by. Defaults to 'fullName'." }, { "disabled": false, "key": "sortOrder", "value": "string", "description": "Sort order: 'asc' or 'desc'. Defaults to 'asc'." }, { "disabled": false, "key": "sortPriorityListId", "value": "7621", "description": "If provided, contacts belonging to this list are sorted first." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "52bb498e-ed46-449e-990e-1835931f792a", "name": "Contacts retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "communicationSupported", "value": "string" }, { "key": "email", "value": "string" }, { "key": "gender", "value": "string" }, { "key": "id", "value": "7621" }, { "key": "isTest", "value": "true" }, { "key": "isValid", "value": "true" }, { "key": "lastCampaignType", "value": "string" }, { "key": "lastContactType", "value": "string" }, { "key": "limit", "value": "974" }, { "key": "listIds", "value": "string" }, { "key": "notListIds", "value": "string" }, { "key": "page", "value": "7225" }, { "key": "phoneNumber", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" }, { "key": "sortPriorityListId", "value": "7621" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 5362,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 2356,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 3744,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": false,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 9279,\n 7493\n ]\n },\n {\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 616,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 2396,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 408,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": false,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 4414,\n 280\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4010cda4-9ac5-491e-8166-903e4caa6f31", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "communicationSupported", "value": "string" }, { "key": "email", "value": "string" }, { "key": "gender", "value": "string" }, { "key": "id", "value": "7621" }, { "key": "isTest", "value": "true" }, { "key": "isValid", "value": "true" }, { "key": "lastCampaignType", "value": "string" }, { "key": "lastContactType", "value": "string" }, { "key": "limit", "value": "974" }, { "key": "listIds", "value": "string" }, { "key": "notListIds", "value": "string" }, { "key": "page", "value": "7225" }, { "key": "phoneNumber", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" }, { "key": "sortPriorityListId", "value": "7621" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8994ef50-32ec-409b-8ea5-98969e02de79", "name": "Delete contacts", "request": { "name": "Delete contacts", "description": { "content": "Deletes contacts from your account. This endpoint supports two mutually exclusive modes. Mode 1 (selective delete): Provide ids as a comma-separated list of contact IDs to delete specific contacts. When ids is present, the notIds parameter is ignored. Mode 2 (bulk delete with exclusions): Provide notIds as a comma-separated list of contact IDs to keep, and all other contacts in your account will be deleted. This operation permanently removes the contact records and also removes their associations with any contact lists. Deleted contacts will no longer be available as recipients for future campaigns. Delivery history for past campaigns that included these contacts is preserved. Use this with caution, especially Mode 2, as it can delete a large number of contacts in a single call. Returns 200 with the result of the deletion operation. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "string", "description": "Comma-separated list of contact IDs to delete. If present, 'notIds' is ignored." }, { "disabled": false, "key": "notIds", "value": "string", "description": "Comma-separated list of contact IDs to exclude from deletion." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ab147fe6-174c-486e-b3bb-dfc42b1cf738", "name": "Contacts deleted successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "string" }, { "key": "notIds", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff724129-7a29-496f-a7d5-151f23ab45da", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "string" }, { "key": "notIds", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a5fc7e1-b514-47c6-8c6d-2320a420363a", "name": "Create a new contact", "request": { "name": "Create a new contact", "description": { "content": "Creates a new individual contact in your account. You must provide at least a phone number or an email address. The phone number should be in E.164 international format (e.g., +393331234567). You can include optional fields such as firstName, lastName, gender, and any custom fields your account has configured. After creating a contact, you can assign it to one or more contact lists using POST /contacts/list/contacts so it becomes a recipient in campaigns. For bulk imports, use POST /contacts/upload (CSV/Excel) or POST /contacts/upload/vcard (VCF) instead of creating contacts one by one. Returns 201 with the created contact details including the generated contact ID. Returns 400 if the request body is missing required fields or contains invalid data (e.g., malformed phone number). Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "831c94fa-7c66-4b39-baea-cdccac083133", "name": "Contact created successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contacts\": [\n {\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 7295,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 7557,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 427,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": false,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 8762,\n 1350\n ]\n },\n {\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 8146,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 8097,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 8298,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": true,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 3755,\n 2765\n ]\n }\n ],\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa82c93-b1be-4171-b254-6402a7f33274", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92a65c2a-e62e-4c1e-afa6-8740ae17cd91", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16dce455-bb9b-4fd1-a71e-152aa30355fe", "name": "Upload and parse a contact list file", "request": { "name": "Upload and parse a contact list file", "description": { "content": "Uploads a tabular file and imports its rows as contacts into your account. Supported file formats include CSV (.csv), Microsoft Excel (.xls, .xlsx), and other delimited text files. The file format is detected from the fileName extension. The file must be sent as multipart/form-data with the file in the 'file' field and the original filename in the 'fileName' field. Set removeHead=true if the first row of the file contains column headers that should not be imported as a contact record. The limit parameter controls how many parsed rows are returned in the response preview (defaults to 10) but does not limit the actual number of contacts imported. The import runs in CREATE_UPDATE mode: new contacts are created, and existing contacts (matched by phone number) are updated with the new data. If a listId is provided, all successfully imported contacts are automatically added to that contact list. Column mapping is performed automatically based on recognized header names (e.g., firstName, lastName, phoneNumber, email). Returns 400 if the file type is not supported, the file is corrupted, or the file cannot be parsed. Returns 500 if an unexpected server error occurs during import processing.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "10", "description": "Maximum number of parsed lines to return. Defaults to 10." }, { "disabled": false, "key": "removeHead", "value": "true", "description": "If true, the first line of the file (header) is excluded from parsing." } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "" }, { "key": "fileName", "value": "string", "type": "text", "description": "" } ] } }, "response": [ { "id": "c2f06992-d6c1-4852-918f-b7e4a536966d", "name": "File parsed successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "removeHead", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "fileName", "value": "string", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c230e241-4103-4724-a55e-b184d5b0fe3d", "name": "Invalid file or unsupported file type", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "removeHead", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "fileName", "value": "string", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23b83fa-e03a-4be3-992e-09ead8b35661", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "removeHead", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "fileName", "value": "string", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50195f98-d072-4efc-a54d-f488d1ff505a", "name": "Upload and parse a VCard file", "request": { "name": "Upload and parse a VCard file", "description": { "content": "Uploads a VCard (.vcf) file and imports its entries as contacts into your account. The file must be sent as multipart/form-data with the file in the 'file' field and the original filename (must have .vcf extension) in the 'fileName' field. VCard files can contain one or multiple contact entries. Each vCard entry is parsed and mapped to a contact record using standard vCard fields (FN, TEL, EMAIL, etc.). The import runs in CREATE_UPDATE mode: new contacts are created, and existing contacts (matched by phone number) are updated with the data from the VCard. If a listId is provided, all successfully imported contacts are automatically added to that contact list. The limit parameter controls how many parsed contacts are returned in the response preview (defaults to 10) but does not limit the actual number of contacts imported. This endpoint is particularly useful for importing contacts exported from phone address books, Outlook, Google Contacts, or other CRM tools that support the VCard standard. Returns 400 if the file does not have a .vcf extension or is not a valid VCard file. Returns 500 if an unexpected server error occurs during import processing.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "upload", "vcard" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "10", "description": "Maximum number of parsed contacts to return. Defaults to 10." } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "" }, { "key": "fileName", "value": "string", "type": "text", "description": "" } ] } }, "response": [ { "id": "fa115f11-6e2c-4ded-a57e-3697e322c40b", "name": "VCard file parsed successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "upload", "vcard" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "fileName", "value": "string", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b03a161d-d701-409d-8d93-ad0993a67138", "name": "Invalid file or unsupported file type (only .vcf allowed)", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "upload", "vcard" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "fileName", "value": "string", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04d2511a-e24b-472c-a1fa-9ce059702aca", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "upload", "vcard" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "fileName", "value": "string", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20bb9b29-babd-45e2-999b-5fe307711ed9", "name": "Update a contact", "request": { "name": "Update a contact", "description": { "content": "Updates an existing contact identified by its numeric ID. You can modify any contact field: name, phone number, email, gender, custom fields, etc. Only the fields provided in the request body will be updated; omitted fields remain unchanged. Use GET /contacts/{id} first to retrieve the current values if you need to perform a partial update and want to preserve existing data. Updating a contact phone number may affect its validity status and communication capabilities (e.g., a new number might not support RCS). Contact list memberships are not affected by this endpoint; use the /contacts/list/contacts endpoints to manage list associations. Returns 200 with the updated contact details. Returns 400 if the request body contains invalid data. Returns 404 if no contact exists with the given ID under your account. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "191a1d3a-3518-4428-b9d7-cb42a57d61aa", "name": "Contact updated successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to update." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contacts\": [\n {\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 7295,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 7557,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 427,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": false,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 8762,\n 1350\n ]\n },\n {\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 8146,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 8097,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 8298,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": true,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 3755,\n 2765\n ]\n }\n ],\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72aec803-1f72-484d-a6a6-f46fa5ba362c", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to update." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b8975ac-228d-4fdc-968e-90b681a982eb", "name": "Contact not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to update." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cf7a0cc-4aa1-4c04-aad3-653c84b89e94", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to update." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"Luigi\",\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\",\n \"gender\": \"M\",\n \"nickname\": \"Mari\",\n \"phoneNumbers\": [\n \"+393331234567\",\n \"+390212345678\"\n ],\n \"emailAddresses\": [\n \"mario.rossi@email.com\",\n \"mario.rossi@work.com\"\n ],\n \"mainEmail\": \"mario.rossi@email.com\",\n \"addresses\": [\n \"Via Roma 1, 20121 Milano, IT\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"Software Engineer\",\n \"organization\": \"Acme S.r.l.\",\n \"website\": \"https://www.mariorossi.it\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"VIP customer — high priority\",\n \"companyName\": \"Acme S.r.l.\",\n \"companyMail\": \"info@acme.it\",\n \"companyPhone\": \"+39 02 9876543\",\n \"companyFax\": \"+39 02 9876544\",\n \"city\": \"Milano\",\n \"completeCompanyAddress\": \"Via Montenapoleone 1, 20121 Milano, Italy\",\n \"fiscalCode\": \"RSSMRA90E15F205Z\",\n \"sector\": \"Technology\",\n \"referenceContact\": \"Giuseppe Verdi\",\n \"source\": \"manual\",\n \"leadType\": \"inbound\",\n \"stage\": \"qualified\",\n \"channel\": \"email\",\n \"owner\": \"agent@acme.it\",\n \"tags\": [\n \"vip\",\n \"newsletter\",\n \"q4-promo\"\n ],\n \"customField1\": \"value1\",\n \"customField2\": \"value2\",\n \"customField3\": \"value3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78f7fcf7-a110-4eac-b9ae-f6eaca471ef8", "name": "Get contact by ID", "request": { "name": "Get contact by ID", "description": { "content": "Retrieves the full details of a single contact by its numeric ID. The response includes all stored fields: name, phone number, email, gender, validity status, communication capabilities, custom fields, and any associated contact list memberships. Use this endpoint to inspect a contact record before updating it with PUT /contacts/{id}, or to verify the details of a contact after creation. Returns 404 if no contact exists with the given ID under your account. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to retrieve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5389c426-bf7a-46f6-9ffc-5de91ab2207b", "name": "Contact retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to retrieve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 3970,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 4768,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 2583,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": true,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 702,\n 9291\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d801ab9-7e0b-4e74-b622-151d1a56efe9", "name": "Contact not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to retrieve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b6933c5-60b6-4d6d-abd2-4d42b0b3e7c0", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact to retrieve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2b96c8bb-38d3-4066-b259-f0f7bbc07036", "name": "Contact List", "description": { "content": "Organise contacts into named lists used as campaign targets.", "type": "text/plain" }, "item": [ { "id": "353457d8-f402-41a1-b0a2-93b64c73d141", "name": "Find contact lists", "request": { "name": "Find contact lists", "description": { "content": "Returns a paginated list of contact lists in your account matching the provided filters. Contact lists are named groups of contacts that serve as the recipient audience for campaigns. A single contact can belong to multiple lists. Use the search parameter to find lists by name (case-insensitive partial match). Use id (comma-separated) to retrieve specific lists by their IDs. Use contactIds (comma-separated) to find all lists that contain specific contacts, which is useful for understanding which lists a contact is a member of. Set isTest=true to retrieve only test lists used for sending test campaigns, or isTest=false to exclude them. By default, deleted lists are excluded. Set includeDeleted=true to include soft-deleted lists in the results. Results are paginated: page is 0-based, limit defaults to 10 (maximum 1000). Use sortBy to choose the sort field (defaults to name) and sortOrder for asc or desc. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "contactIds", "value": "string", "description": "Comma-separated list of contact IDs to filter by." }, { "disabled": false, "key": "id", "value": "string", "description": "Comma-separated list of contact list IDs to filter by." }, { "disabled": false, "key": "includeDeleted", "value": "true", "description": "Include deleted contact lists." }, { "disabled": false, "key": "isTest", "value": "true", "description": "Filter by test flag." }, { "disabled": false, "key": "limit", "value": "974", "description": "Maximum number of results per page. Defaults to 10." }, { "disabled": false, "key": "page", "value": "7225", "description": "Page number (0-based). Defaults to 0." }, { "disabled": false, "key": "search", "value": "string", "description": "Search string to filter contact lists by name." }, { "disabled": false, "key": "sortBy", "value": "string", "description": "Field to sort by. Defaults to 'name'." }, { "disabled": false, "key": "sortOrder", "value": "string", "description": "Sort order: 'asc' or 'desc'. Defaults to 'asc'." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "522629db-da95-4f66-ad2b-df95e6a67f1a", "name": "Contact lists retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "contactIds", "value": "string" }, { "key": "id", "value": "string" }, { "key": "includeDeleted", "value": "true" }, { "key": "isTest", "value": "true" }, { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 1,\n \"name\": \"Newsletter VIP\",\n \"description\": \"string\",\n \"filters\": [\n \"string\",\n \"string\"\n ],\n \"fkIdCompany\": 992,\n \"numContact\": 150,\n \"isTest\": false,\n \"isDeleted\": false,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\"\n },\n {\n \"id\": 1,\n \"name\": \"Newsletter VIP\",\n \"description\": \"string\",\n \"filters\": [\n \"string\",\n \"string\"\n ],\n \"fkIdCompany\": 5759,\n \"numContact\": 150,\n \"isTest\": false,\n \"isDeleted\": false,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64cba710-53ab-47b3-b84c-c179611c3640", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "contactIds", "value": "string" }, { "key": "id", "value": "string" }, { "key": "includeDeleted", "value": "true" }, { "key": "isTest", "value": "true" }, { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54df1033-87aa-4928-9615-8e2166d882b1", "name": "Delete contact lists", "request": { "name": "Delete contact lists", "description": { "content": "Deletes one or more contact lists by their IDs. Provide the ids parameter as a comma-separated list of contact list IDs to delete. Deleting a contact list removes the list and all associations between that list and its contacts, but does not delete the contacts themselves. The contacts remain in your account and can still belong to other lists. If a deleted list is currently assigned to a draft or scheduled campaign, you should update that campaign to remove the deleted list from its contactListIds before confirming it, otherwise the campaign may fail validation. This operation is irreversible. Returns 200 with the result of the deletion operation. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "string", "description": "(Required) Comma-separated list of contact list IDs to delete." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "50e160bb-bbdf-4ee3-8d9d-3d13b2e9a91a", "name": "Contact lists deleted successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8863c5b-f717-430d-a5fc-42f8f68b7eb0", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6ccfd75-c99f-4a91-904a-755b67712655", "name": "Create a new contact list", "request": { "name": "Create a new contact list", "description": { "content": "Creates a new empty contact list in your account. A contact list is a named group that acts as a recipient audience for campaigns. You must provide at least a name for the list. After creating the list, populate it by adding contacts using POST /contacts/list/contacts (for existing contacts) or by importing contacts from a file with POST /contacts/upload or POST /contacts/upload/vcard (which can auto-assign imported contacts to the list). You can then assign the list to one or more campaigns by including its ID in the contactListIds field when creating or updating a campaign. Set the isTest flag to true if this list is intended for testing purposes only (e.g., sending test messages to internal recipients before launching a real campaign). Returns 201 with the created contact list details including the generated list ID. Returns 400 if the request body is missing required fields or contains invalid data. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "22cf159b-793a-4c2c-bce6-dcd10dfe32eb", "name": "Contact list created successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"name\": \"Newsletter VIP\",\n \"description\": \"string\",\n \"filters\": [\n \"string\",\n \"string\"\n ],\n \"fkIdCompany\": 4395,\n \"numContact\": 150,\n \"isTest\": false,\n \"isDeleted\": true,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09a58741-8d9b-4c79-8fb7-dc28f0a1f84a", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4f96e2a-76d0-4e2a-9cdc-db0c6743d185", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d40e5019-b3ae-4adb-902a-d5982fc63bc5", "name": "Delete contacts from contact lists", "request": { "name": "Delete contacts from contact lists", "description": { "content": "Removes contacts from contact lists in bulk by deleting their associations. The request body must include listIds (the target contact lists to remove contacts from) and either specific contactIds or allContacts=true. When allContacts is false, provide contactIds as a list of contact IDs to remove from the specified lists. The contactIds field is required in this mode. When allContacts is true, all contacts are removed from the specified lists, except those whose IDs are in excludeIdsAllContacts. This operation only removes the contact-to-list associations; it does not delete the contacts themselves or the lists. Contacts removed from a list will no longer be recipients of campaigns that target that list, unless they also belong to another list used by the same campaign. Use this to clean up list memberships, prepare lists for re-import, or narrow down a campaign audience. For deleting a single association by its ID, use DELETE /contacts/list/contacts/{id} instead. Returns 200 with the result of the dissociation operation. Returns 400 if listIds is empty, or if allContacts is false and contactIds is not provided. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 8714\n ],\n \"contactIds\": [\n 4698,\n 1784\n ],\n \"allContacts\": true,\n \"excludeIdsAllContacts\": [\n 2029,\n 1897\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c0c3e51e-1851-479c-a670-c952f008263f", "name": "Associations deleted successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 5679\n ],\n \"contactIds\": [\n 2639,\n 3471\n ],\n \"allContacts\": false,\n \"excludeIdsAllContacts\": [\n 1973,\n 365\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31eaa628-4410-4975-b10f-945728c27d2f", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 5679\n ],\n \"contactIds\": [\n 2639,\n 3471\n ],\n \"allContacts\": false,\n \"excludeIdsAllContacts\": [\n 1973,\n 365\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "201afc38-954e-4007-9aa4-1421de6d5fbb", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 5679\n ],\n \"contactIds\": [\n 2639,\n 3471\n ],\n \"allContacts\": false,\n \"excludeIdsAllContacts\": [\n 1973,\n 365\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e6c5e2b-f1d4-4bf2-838a-70f8c0752a89", "name": "Add contacts to contact lists", "request": { "name": "Add contacts to contact lists", "description": { "content": "Creates associations between contacts and contact lists, effectively adding contacts as members of the specified lists. The request body must include listIds (the target contact lists) and either specific contactIds or allContacts=true. When allContacts is false, provide contactIds as a list of contact IDs to add to the specified lists. When allContacts is true, all contacts in your account are added to the specified lists, except those whose IDs are in excludeIdsAllContacts. This is a bulk operation: you can add multiple contacts to multiple lists in a single call. If a contact is already a member of a given list, the existing association is preserved (no duplicate is created). After adding contacts to lists, the updated lists can be used as campaign audiences by including them in a campaign's contactListIds. Returns 201 with the IDs of the created associations. Returns 400 if listIds is empty or the request body is otherwise invalid. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 4617\n ],\n \"contactIds\": [\n 3925,\n 5452\n ],\n \"allContacts\": false,\n \"excludeIdsAllContacts\": [\n 2141,\n 9828\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "11ea2570-3c70-4d92-8a4b-9071c7743de1", "name": "Associations created successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 3594\n ],\n \"contactIds\": [\n 8574,\n 4088\n ],\n \"allContacts\": true,\n \"excludeIdsAllContacts\": [\n 9254,\n 5032\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n 3967,\n 3533\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd9ca613-7d20-4a89-a869-d3f4ce91fd05", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 3594\n ],\n \"contactIds\": [\n 8574,\n 4088\n ],\n \"allContacts\": true,\n \"excludeIdsAllContacts\": [\n 9254,\n 5032\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f18a12d-f608-4fe4-ad35-951e3c169c3f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 3594\n ],\n \"contactIds\": [\n 8574,\n 4088\n ],\n \"allContacts\": true,\n \"excludeIdsAllContacts\": [\n 9254,\n 5032\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85606ef6-ad02-4fcc-a318-72a4751f292c", "name": "Delete association by ID", "request": { "name": "Delete association by ID", "description": { "content": "Deletes a single association between a contact and a contact list, identified by the association's numeric ID. This removes the contact from the list but does not delete the contact itself or the list. The association ID is a unique identifier for the link between a specific contact and a specific list. You can obtain association IDs from the response of POST /contacts/list/contacts when the associations were created. For bulk removal of contacts from lists, use DELETE /contacts/list/contacts/ instead, which supports removing multiple contacts at once. Returns 200 on successful deletion of the association. Returns 404 if no association exists with the given ID under your account. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the association to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2eeb4d25-45b1-40b6-b8d7-aec83eda504c", "name": "Association deleted successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the association to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68c6a062-b895-4929-8eb5-a77a6b4982a4", "name": "Association not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the association to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bc6c9df-ec23-4f89-8b22-b6d221aaa4aa", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the association to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2110bb98-e82d-4821-98bf-0e749ed09cea", "name": "Update a contact list", "request": { "name": "Update a contact list", "description": { "content": "Updates the metadata of an existing contact list identified by its numeric ID. You can modify the list name, description, and isTest flag. This endpoint only updates the list metadata; it does not add or remove contacts from the list. To add or remove contacts, use POST /contacts/list/contacts and DELETE /contacts/list/contacts/ respectively. If the list is currently assigned to a campaign, the campaign will automatically use the updated list metadata. Returns 200 with the updated contact list details. Returns 400 if the request body contains invalid data. Returns 404 if no contact list exists with the given ID under your account. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3ef25ae3-c80d-4f10-b05b-5e9e4ef5b108", "name": "Contact list updated successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to update." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"name\": \"Newsletter VIP\",\n \"description\": \"string\",\n \"filters\": [\n \"string\",\n \"string\"\n ],\n \"fkIdCompany\": 4395,\n \"numContact\": 150,\n \"isTest\": false,\n \"isDeleted\": true,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50007f2a-97ff-4d6e-9243-660f5d21514a", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to update." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f91fd6fe-4b51-4102-a476-4e36e718ac4a", "name": "Contact list not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to update." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f568dc6c-4f3a-43ef-a867-f3eaeecb9dbb", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to update." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Newsletter VIP\",\n \"description\": \"Contact list for VIP newsletter subscribers\",\n \"filters\": [\n {\n \"field\": \"city\",\n \"operand\": \"equals\",\n \"value\": \"Milano\"\n },\n {\n \"field\": \"stage\",\n \"operand\": \"equals\",\n \"value\": \"qualified\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9125c69a-69d2-4c59-ab4e-45496a7b00ee", "name": "Get contact list by ID", "request": { "name": "Get contact list by ID", "description": { "content": "Retrieves the full details of a single contact list by its numeric ID. The response includes the list name, description, creation date, contact count, and whether it is marked as a test list. Use this endpoint to inspect a list before assigning it to a campaign via POST /campaigns or PUT /campaigns/{id}. To retrieve the actual contacts within this list, use GET /contacts/list/{listId}/contacts. Returns 404 if no contact list exists with the given ID under your account. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to retrieve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c98a4901-a903-4ae4-b6db-157458264589", "name": "Contact list retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to retrieve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"name\": \"Newsletter VIP\",\n \"description\": \"string\",\n \"filters\": [\n \"string\",\n \"string\"\n ],\n \"fkIdCompany\": 4395,\n \"numContact\": 150,\n \"isTest\": false,\n \"isDeleted\": true,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "987f3f08-863c-4c11-9993-ac6a22b8f0b3", "name": "Contact list not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to retrieve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a49e5f5-9ec1-4fc0-aa06-4ca6aaab4275", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the contact list to retrieve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e7f4b1c-9516-4fbf-a855-2a3b982d0235", "name": "Find contacts in a contact list", "request": { "name": "Find contacts in a contact list", "description": { "content": "Returns the contacts belonging to a specific contact list, with optional filters and pagination. This is a convenience endpoint equivalent to calling GET /contacts with the listIds parameter set to the given listId. All the same contact-level filters are available: search (case-insensitive text match against name), gender, isValid, communicationSupported (e.g., SMS, RCS, WHATSAPP), isTest, phoneNumber, email, lastContactType, and lastCampaignType. Results are paginated: page is 0-based, limit defaults to 10 (maximum 1000). Use sortBy to choose the sort field (defaults to fullName) and sortOrder for asc or desc. Use this endpoint to preview the audience of a contact list before assigning it to a campaign, or to verify which contacts were imported after a file upload. Returns 404 if no contact list exists with the given listId under your account. Returns 500 if an unexpected server error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":listId", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "communicationSupported", "value": "string", "description": "Filter by supported communication channel." }, { "disabled": false, "key": "email", "value": "string", "description": "Filter by email." }, { "disabled": false, "key": "gender", "value": "string", "description": "Filter by gender." }, { "disabled": false, "key": "isTest", "value": "true", "description": "Filter by test flag." }, { "disabled": false, "key": "isValid", "value": "true", "description": "Filter by validity flag." }, { "disabled": false, "key": "lastCampaignType", "value": "string", "description": "Filter by last campaign type." }, { "disabled": false, "key": "lastContactType", "value": "string", "description": "Filter by last contact type." }, { "disabled": false, "key": "limit", "value": "974", "description": "Maximum number of results per page. Defaults to 10." }, { "disabled": false, "key": "page", "value": "7225", "description": "Page number (0-based). Defaults to 0." }, { "disabled": false, "key": "phoneNumber", "value": "string", "description": "Filter by phone number." }, { "disabled": false, "key": "search", "value": "string", "description": "Search string matched against name and other fields." }, { "disabled": false, "key": "sortBy", "value": "string", "description": "Field to sort by. Defaults to 'fullName'." }, { "disabled": false, "key": "sortOrder", "value": "string", "description": "Sort order: 'asc' or 'desc'. Defaults to 'asc'." } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "listId", "description": "(Required) ID of the contact list to retrieve contacts from." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d600270e-3381-4348-a191-52116fd3418c", "name": "Contacts retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":listId", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "communicationSupported", "value": "string" }, { "key": "email", "value": "string" }, { "key": "gender", "value": "string" }, { "key": "isTest", "value": "true" }, { "key": "isValid", "value": "true" }, { "key": "lastCampaignType", "value": "string" }, { "key": "lastContactType", "value": "string" }, { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" }, { "key": "phoneNumber", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "listId", "description": "(Required) ID of the contact list to retrieve contacts from." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 5362,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 2356,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 3744,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": false,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 9279,\n 7493\n ]\n },\n {\n \"id\": 12345,\n \"fullName\": \"Mario Rossi\",\n \"firstName\": \"Mario\",\n \"lastName\": \"Rossi\",\n \"middleName\": \"string\",\n \"prefix\": \"string\",\n \"suffix\": \"string\",\n \"gender\": \"string\",\n \"nickname\": \"string\",\n \"phoneNumbers\": [\n \"+39333123456\"\n ],\n \"emailAddresses\": [\n \"mario@example.com\"\n ],\n \"mainEmail\": \"mario@example.com\",\n \"addresses\": [\n \"string\",\n \"string\"\n ],\n \"country\": \"Italy\",\n \"jobTitle\": \"string\",\n \"organization\": \"string\",\n \"website\": \"string\",\n \"birthday\": \"2022-03-10\",\n \"notes\": \"string\",\n \"fkIdCompany\": 616,\n \"companyName\": \"string\",\n \"companyMail\": \"string\",\n \"companyPhone\": \"string\",\n \"companyFax\": \"string\",\n \"completeCompanyAddress\": \"string\",\n \"fiscalCode\": \"string\",\n \"sector\": \"string\",\n \"referenceContact\": \"string\",\n \"isValid\": true,\n \"mobilePhoneNumber\": \"+39333123456\",\n \"mobilePhoneNumberMccmnc\": 2396,\n \"city\": \"Milano\",\n \"source\": \"string\",\n \"leadType\": \"string\",\n \"stage\": \"string\",\n \"channel\": \"string\",\n \"owner\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"numCampaignSent\": 408,\n \"lastContactDate\": \"2022-03-10\",\n \"lastContactType\": \"string\",\n \"lastCampaignDate\": \"2022-03-10\",\n \"lastCampaignType\": \"string\",\n \"communicationSupported\": [\n \"string\",\n \"string\"\n ],\n \"customField1\": \"string\",\n \"customField2\": \"string\",\n \"customField3\": \"string\",\n \"isTest\": false,\n \"createdAt\": \"2022-03-10\",\n \"updatedAt\": \"2022-03-10\",\n \"listIds\": [\n 4414,\n 280\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "249b17a7-224b-4c49-a860-7136b77191a9", "name": "Contact list not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":listId", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "communicationSupported", "value": "string" }, { "key": "email", "value": "string" }, { "key": "gender", "value": "string" }, { "key": "isTest", "value": "true" }, { "key": "isValid", "value": "true" }, { "key": "lastCampaignType", "value": "string" }, { "key": "lastContactType", "value": "string" }, { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" }, { "key": "phoneNumber", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "listId", "description": "(Required) ID of the contact list to retrieve contacts from." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb76ddde-1db8-4587-befa-4c2dbb9670f6", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "contacts", "list", ":listId", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "communicationSupported", "value": "string" }, { "key": "email", "value": "string" }, { "key": "gender", "value": "string" }, { "key": "isTest", "value": "true" }, { "key": "isValid", "value": "true" }, { "key": "lastCampaignType", "value": "string" }, { "key": "lastContactType", "value": "string" }, { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" }, { "key": "phoneNumber", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "listId", "description": "(Required) ID of the contact list to retrieve contacts from." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "33e5c194-ed3c-4857-8f0e-9cd677ef2fe2", "name": "Export", "description": { "content": "Asynchronously export contacts or delivery reports as downloadable files.", "type": "text/plain" }, "item": [ { "id": "73a913c2-e720-4443-853f-a931cbfcd1b0", "name": "List exports", "request": { "name": "List exports", "description": { "content": "Returns a paginated list of all export jobs for your account, ordered by creation date. This is the primary polling endpoint in the asynchronous export workflow. After you create an export job via POST /exports/contacts or POST /exports/delivery-reports, the job is queued and processed in the background. Call this endpoint periodically (recommended interval: every 5-10 seconds) to monitor progress. Each export entry includes a status field and an isAvailableForDownload flag. Once isAvailableForDownload becomes true, call GET /exports/{exportId} to retrieve the time-limited download URL. Download URLs expire after a period of time. If the URL has expired, the isAvailableForDownload flag may revert to false; in that case use POST /exports/{exportId} to regenerate the export and obtain a fresh URL. Pagination is controlled by page (0-based) and limit (items per page, default 10). Returns 500 if an internal error occurs while fetching the export list.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "10", "description": "Page size." }, { "disabled": false, "key": "page", "value": "0", "description": "Page index (0-based)." }, { "disabled": false, "key": "userId", "value": "0", "description": "User ID (optional – defaults to 0 for API-key callers)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a142bde1-58e1-4431-bb43-558f54bb233d", "name": "Paginated list of exports", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "0" }, { "key": "userId", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"page\": 0,\n \"limit\": 10,\n \"totalCount\": 42,\n \"totalPages\": 5\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "540f9dd5-c550-41fe-87ee-9bbcb27d4e7f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "0" }, { "key": "userId", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afdceff3-7eea-4baa-b9c1-20ee51623b81", "name": "Export contacts", "request": { "name": "Export contacts", "description": { "content": "Queues an asynchronous CSV export of contacts from your account. You can scope the export in three ways: (1) provide listIds to export all contacts belonging to one or more contact lists, (2) provide contactIds to export a specific set of contacts by their IDs, or (3) omit both to export every contact in your account. The endpoint returns 202 Accepted immediately, meaning the export job has been queued but not yet completed. To track progress, poll GET /exports periodically (every 5-10 seconds is recommended). When the job finishes and isAvailableForDownload becomes true, call GET /exports/{exportId} to retrieve the time-limited download URL for the CSV file. If you need to export the same data again after the URL expires, use POST /exports/{exportId} to regenerate the export. Returns 400 if the request body is invalid (e.g. malformed list IDs or contact IDs). Returns 500 if an internal error occurs while queuing the job.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "exports", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "userId", "value": "0", "description": "User ID (optional – defaults to 0 for API-key callers)." } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 4919,\n 1280\n ],\n \"contactIds\": [\n 4074,\n 1228\n ],\n \"excludeContactIds\": [\n 8913,\n 92\n ],\n \"exportFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e1c7087-4e3a-43e0-95cd-59dd02d301d8", "name": "Export job queued", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 2280,\n 3479\n ],\n \"contactIds\": [\n 8947,\n 4099\n ],\n \"excludeContactIds\": [\n 6373,\n 6541\n ],\n \"exportFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50344cb6-4b1b-4740-b0bc-8d9a177df3e6", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 2280,\n 3479\n ],\n \"contactIds\": [\n 8947,\n 4099\n ],\n \"excludeContactIds\": [\n 6373,\n 6541\n ],\n \"exportFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47662bc1-bffa-4963-8e4c-cc4663274fd9", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listIds\": [\n 2280,\n 3479\n ],\n \"contactIds\": [\n 8947,\n 4099\n ],\n \"excludeContactIds\": [\n 6373,\n 6541\n ],\n \"exportFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a06a749-8d83-4e0d-81da-8205ab92db71", "name": "Export delivery reports", "request": { "name": "Export delivery reports", "description": { "content": "Queues an asynchronous CSV export of delivery reports (message-level send and delivery statuses). You can scope the export in two ways: (1) provide a campaignId to export delivery reports for a specific campaign, or (2) provide a date range using startDateTime and endDateTime to export all delivery reports within that period. The endpoint returns 202 Accepted immediately, meaning the export job has been queued but not yet completed. To track progress, poll GET /exports periodically (every 5-10 seconds is recommended). When the job finishes and isAvailableForDownload becomes true, call GET /exports/{exportId} to retrieve the time-limited download URL for the CSV file. If you need to export the same data again after the URL expires, use POST /exports/{exportId} to regenerate the export. Returns 400 if the request body is invalid (e.g. missing both campaignId and date range, or invalid date format). Returns 500 if an internal error occurs while queuing the job.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "exports", "delivery-reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "userId", "value": "0", "description": "User ID (optional – defaults to 0 for API-key callers)." } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"startDateTime\": \"2022-03-10T12:15:50-04:00\",\n \"endDateTime\": \"2022-03-10T12:15:50-04:00\",\n \"sender\": \"string\",\n \"recipient\": \"string\",\n \"campaignId\": 7857,\n \"sendType\": \"WEB_API\",\n \"subAccountId\": \"string\",\n \"exportFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c54c2b24-292c-4128-81e0-86e68a228066", "name": "Export job queued", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", "delivery-reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDateTime\": \"2022-03-10T12:15:50-04:00\",\n \"endDateTime\": \"2022-03-10T12:15:50-04:00\",\n \"sender\": \"string\",\n \"recipient\": \"string\",\n \"campaignId\": 7857,\n \"sendType\": \"WEB_API\",\n \"subAccountId\": \"string\",\n \"exportFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea972c7f-57ca-45bf-b144-a82ec821f4d1", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", "delivery-reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDateTime\": \"2022-03-10T12:15:50-04:00\",\n \"endDateTime\": \"2022-03-10T12:15:50-04:00\",\n \"sender\": \"string\",\n \"recipient\": \"string\",\n \"campaignId\": 7857,\n \"sendType\": \"WEB_API\",\n \"subAccountId\": \"string\",\n \"exportFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf9df8cf-be88-4c9b-b17a-dc280f6267bc", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", "delivery-reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDateTime\": \"2022-03-10T12:15:50-04:00\",\n \"endDateTime\": \"2022-03-10T12:15:50-04:00\",\n \"sender\": \"string\",\n \"recipient\": \"string\",\n \"campaignId\": 7857,\n \"sendType\": \"WEB_API\",\n \"subAccountId\": \"string\",\n \"exportFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31bbf423-5064-4ed2-9aa3-e0c3c2495e4a", "name": "Regenerate expired export", "request": { "name": "Regenerate expired export", "description": { "content": "Re-queues an expired export job so that a fresh downloadable file is generated using the same filters and parameters as the original export. This is useful when the download URL returned by GET /exports/{exportId} has expired and you still need the data. The endpoint returns 202 Accepted immediately. The regeneration is processed asynchronously just like the original export. Poll GET /exports to monitor the new job and, once isAvailableForDownload becomes true, call GET /exports/{exportId} to retrieve the fresh download URL. Returns 400 if the export is still available and has not expired yet (there is no need to regenerate it; just download it). Returns 404 if the exportId does not exist or does not belong to your account. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "userId", "value": "0", "description": "User ID (optional – defaults to 0 for API-key callers)." } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2b71197d-41ea-4bb9-8159-b2e555e10ba3", "name": "Regeneration queued", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76636d70-6fbb-412d-bafb-b160bc44acab", "name": "Export is still available and has not expired", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7c005c3-3f31-4d43-b68c-ccc6f7f0063b", "name": "Export not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9feb8f79-2645-4a1e-a9c3-311867a7cd01", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ffe7df55-74e9-499c-863c-d0d47ce090a2", "name": "Get export download URL", "request": { "name": "Get export download URL", "description": { "content": "Returns a pre-signed download URL for a completed export file. You should only call this endpoint after confirming that the export has finished processing by checking that isAvailableForDownload is true in the GET /exports list response. The returned URL is time-limited and will expire after a certain period. Once expired, any attempt to download the file using that URL will fail. If you need a fresh link after expiration, call POST /exports/{exportId} to regenerate the export, then poll GET /exports again until the new export is ready and retrieve the new download URL from this endpoint. Returns 400 if the export has expired and is no longer available for direct download (use POST /exports/{exportId} to regenerate). Returns 404 if the exportId does not exist or does not belong to your account. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "userId", "value": "0", "description": "User ID (optional – defaults to 0 for API-key callers)." } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f491a156-3c65-4c0f-b0da-047ea7ab4c7f", "name": "Download URL", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"https://storage.example.com/exports/42.csv?token=abc123&expires=1700000000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21a63fe4-fed2-467c-b988-8309e4c45f3c", "name": "Export no longer available", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d7ee6ed-26fe-498b-a471-c153e4531311", "name": "Export not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1ea39fd-0550-461a-b944-becaf0de4e2f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "exports", ":exportId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "userId", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "exportId", "description": "(Required) Export identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8fe99404-2b3b-46ae-9a04-79ab7fb99746", "name": "Inbox", "description": { "content": "Manage two-way conversations with your contacts.", "type": "text/plain" }, "item": [ { "id": "a12ea844-1f2e-47dc-a772-fc5847a5ab72", "name": "List inbox conversations", "request": { "name": "List inbox conversations", "description": { "content": "Returns all two-way conversations for your account. A conversation groups every message exchanged with a single contact on a given channel (WhatsApp, RCS, etc.) into one thread. Conversations are created automatically when a contact sends an inbound message or when you send a reply through the Inbox. Use the filter parameters to narrow results: dateFrom limits to conversations updated after a given ISO date, channelIds restricts to one or more channels, and unreadOnly=true returns only conversations that contain messages you have not yet marked as read. Sorting is controlled by orderBy; prefix the field name with - for descending or + for ascending (e.g. -lastMessageDate for newest first). Each returned conversation includes an unread counter. To clear it, call PATCH /conversations/{chatId}/read. Conversations you no longer need in your default view can be moved out with PATCH /conversations/{chatId}/archive and restored later with PATCH /conversations/{chatId}/unarchive. A 401 response means the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "channelIds", "value": "string", "description": "Comma-separated channel IDs to filter by (e.g. WHATSAPP-123,RCS-456)" }, { "disabled": false, "key": "dateFrom", "value": "string", "description": "ISO date string to filter conversations updated after this date" }, { "disabled": false, "key": "orderBy", "value": "string", "description": "Sort field with optional +/- prefix (e.g. -lastMessageDate, +contactName)" }, { "disabled": false, "key": "unreadOnly", "value": "true", "description": "If true, returns only conversations with unread messages" }, { "disabled": false, "key": "section", "value": "string", "description": "Inbox section selector. Use it to narrow results by assignment state (for example to retrieve only conversations assigned to the current user, only unassigned conversations, or every conversation in the inbox). Leave empty to return every conversation the caller is allowed to see." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "244abfcd-c3cb-40f0-bd66-94a3a497b171", "name": "Conversations retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channelIds", "value": "string" }, { "key": "dateFrom", "value": "string" }, { "key": "orderBy", "value": "string" }, { "key": "unreadOnly", "value": "true" }, { "key": "section", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 500,\n \"companyId\": 3620,\n \"hasUnreadMessages\": true,\n \"lastCheckedAt\": \"2022-03-10\",\n \"userName\": \"string\",\n \"phoneNumber\": \"+39333123456\",\n \"profilePicture\": \"string\",\n \"unreadCount\": 3874,\n \"lastMessageText\": \"Thanks for your help!\",\n \"lastMessageDate\": \"2022-03-10\",\n \"socialMedia\": \"WHATSAPP\",\n \"companyProfileName\": \"string\",\n \"companyProfilePicture\": \"string\",\n \"companyProfileId\": \"string\",\n \"companyPhoneNumber\": \"string\",\n \"companyPhoneNumberType\": \"string\",\n \"whatsappWindowExpire\": \"2022-03-10\",\n \"assignedUserId\": 623\n },\n {\n \"id\": 500,\n \"companyId\": 4674,\n \"hasUnreadMessages\": true,\n \"lastCheckedAt\": \"2022-03-10\",\n \"userName\": \"string\",\n \"phoneNumber\": \"+39333123456\",\n \"profilePicture\": \"string\",\n \"unreadCount\": 4938,\n \"lastMessageText\": \"Thanks for your help!\",\n \"lastMessageDate\": \"2022-03-10\",\n \"socialMedia\": \"WHATSAPP\",\n \"companyProfileName\": \"string\",\n \"companyProfilePicture\": \"string\",\n \"companyProfileId\": \"string\",\n \"companyPhoneNumber\": \"string\",\n \"companyPhoneNumberType\": \"string\",\n \"whatsappWindowExpire\": \"2022-03-10\",\n \"assignedUserId\": 4798\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ffdd5b1-03f8-43be-91ec-a99a456a99e4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channelIds", "value": "string" }, { "key": "dateFrom", "value": "string" }, { "key": "orderBy", "value": "string" }, { "key": "unreadOnly", "value": "true" }, { "key": "section", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3f01754-e399-48bf-b4cf-f25e8f02d2ff", "name": "Send a reply to a conversation", "request": { "name": "Send a reply to a conversation", "description": { "content": "Sends a reply to an existing two-way conversation. The message is delivered on the same channel (WhatsApp, RCS, etc.) that the conversation was originally established on, so you do not need to specify the channel yourself. The reply is accepted asynchronously (202 Accepted) and queued for delivery; the actual delivery status can be tracked through the Webhooks delivery-status callback if you have configured one. The request body must include the conversation ID and the message content. Returns 400 if the request body is malformed or missing required fields. Returns 404 if the conversation does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid. Note: some channels enforce a reply window (e.g. WhatsApp 24-hour window). Attempting to reply outside this window may result in the message failing to deliver.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"chatId\": 500,\n \"message\": \"Thank you for contacting us!\",\n \"replyTo\": 9955,\n \"attachments\": [\n {\n \"mediaId\": 100\n },\n {\n \"mediaId\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "654c03f6-24ce-49cb-9312-3a5ba27e1a82", "name": "Reply accepted for delivery", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chatId\": 500,\n \"message\": \"Thank you for contacting us!\",\n \"replyTo\": 3601,\n \"attachments\": [\n {\n \"mediaId\": 100\n },\n {\n \"mediaId\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0c7ecbe-b5da-4e57-9b02-2e89318264eb", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chatId\": 500,\n \"message\": \"Thank you for contacting us!\",\n \"replyTo\": 3601,\n \"attachments\": [\n {\n \"mediaId\": 100\n },\n {\n \"mediaId\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3db4239-88b1-4801-bb86-c8e4d038c457", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chatId\": 500,\n \"message\": \"Thank you for contacting us!\",\n \"replyTo\": 3601,\n \"attachments\": [\n {\n \"mediaId\": 100\n },\n {\n \"mediaId\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "747395c9-8de3-408a-834e-aea0f876214d", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chatId\": 500,\n \"message\": \"Thank you for contacting us!\",\n \"replyTo\": 3601,\n \"attachments\": [\n {\n \"mediaId\": 100\n },\n {\n \"mediaId\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c67b9d97-16b0-4712-aa28-c9632bbfb58d", "name": "Archive a conversation", "request": { "name": "Archive a conversation", "description": { "content": "Archives a conversation, moving it out of the default inbox view so it no longer appears in the main conversation list returned by GET /conversations. Archiving is a soft operation: no messages are deleted, and the full conversation history is preserved. Use this to keep your inbox clean by hiding resolved or inactive conversations. If the contact sends a new inbound message to an archived conversation, the conversation will typically reappear in the active inbox. To restore an archived conversation manually, call PATCH /conversations/{chatId}/unarchive. Returns 204 on success with no response body. Returns 404 if the conversation does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to archive" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5dc68244-35b9-410d-a1de-6d4832aa49b0", "name": "Conversation archived successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to archive" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea0fa04a-205b-482b-ae7c-7b2d3400f8cf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to archive" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88fd69a2-8d14-4fbb-a367-88057344cd09", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to archive" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a176e1bb-7f37-43ed-9890-e57490d914f8", "name": "Get messages of a conversation", "request": { "name": "Get messages of a conversation", "description": { "content": "Returns the full message thread of a conversation, ordered chronologically. Each message includes direction (inbound or outbound), timestamp, content, and delivery status. For long threads, paginate by message ID: set idFrom to retrieve messages with an ID greater than or equal to a value, and idTo for messages with an ID less than or equal to a value. A typical pagination workflow is to fetch the first page without parameters, then use the highest message ID from the response as idFrom on subsequent calls to load newer messages. After reading messages, call PATCH /conversations/{chatId}/read to clear the unread counter for this conversation. Returns 404 if the chatId does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "idFrom", "value": "7621", "description": "Retrieve messages with ID greater than or equal to this value" }, { "disabled": false, "key": "idTo", "value": "7621", "description": "Retrieve messages with ID less than or equal to this value" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1d01f442-14aa-4109-a814-01fa0f1013e5", "name": "Messages retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "idFrom", "value": "7621" }, { "key": "idTo", "value": "7621" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"profile\": {\n \"userName\": \"string\",\n \"profilePicture\": \"string\",\n \"additionalInfo\": \"string\"\n },\n \"messages\": [\n {\n \"id\": 7950,\n \"text\": \"Hello, how can I help?\",\n \"template\": {},\n \"isUnsupported\": false,\n \"isRead\": true,\n \"replyMessage\": {\n \"id\": 1441,\n \"text\": \"string\",\n \"template\": {},\n \"isInbound\": false,\n \"username\": \"string\",\n \"url\": \"string\"\n },\n \"reaction\": \"string\",\n \"createdAt\": \"2022-03-10T12:15:50-04:00\",\n \"attachments\": [\n {\n \"id\": 5803,\n \"type\": \"string\",\n \"mediaKey\": \"string\",\n \"url\": \"string\",\n \"createdAt\": \"2022-03-10T12:15:50-04:00\"\n },\n {\n \"id\": 7609,\n \"type\": \"string\",\n \"mediaKey\": \"string\",\n \"url\": \"string\",\n \"createdAt\": \"2022-03-10T12:15:50-04:00\"\n }\n ],\n \"isUserReply\": false,\n \"status\": \"DELIVERED\",\n \"isEdited\": true\n },\n {\n \"id\": 7580,\n \"text\": \"Hello, how can I help?\",\n \"template\": {},\n \"isUnsupported\": false,\n \"isRead\": true,\n \"replyMessage\": {\n \"id\": 9214,\n \"text\": \"string\",\n \"template\": {},\n \"isInbound\": true,\n \"username\": \"string\",\n \"url\": \"string\"\n },\n \"reaction\": \"string\",\n \"createdAt\": \"2022-03-10T12:15:50-04:00\",\n \"attachments\": [\n {\n \"id\": 4809,\n \"type\": \"string\",\n \"mediaKey\": \"string\",\n \"url\": \"string\",\n \"createdAt\": \"2022-03-10T12:15:50-04:00\"\n },\n {\n \"id\": 5031,\n \"type\": \"string\",\n \"mediaKey\": \"string\",\n \"url\": \"string\",\n \"createdAt\": \"2022-03-10T12:15:50-04:00\"\n }\n ],\n \"isUserReply\": false,\n \"status\": \"DELIVERED\",\n \"isEdited\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "682651c4-ad6d-401d-bd33-9f9cce8df1e8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "idFrom", "value": "7621" }, { "key": "idTo", "value": "7621" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab96ad2e-5c2f-49be-b7d7-d6c02a02648f", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "idFrom", "value": "7621" }, { "key": "idTo", "value": "7621" } ], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60a08128-2f92-4bfd-9894-06dfda774a60", "name": "Mark a conversation as read", "request": { "name": "Mark a conversation as read", "description": { "content": "Marks all messages in a conversation as read, resetting the unread counter to zero. Call this after your application has displayed the messages to the user so that the unreadOnly filter on GET /conversations accurately reflects which conversations still need attention. This operation is idempotent: calling it on a conversation that is already fully read has no effect and still returns 204. Returns 204 on success with no response body. Returns 404 if the conversation does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to mark as read" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f242791e-4f66-4cf4-ae6b-28f42bd93358", "name": "Conversation marked as read", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to mark as read" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8383c74b-9336-4db9-a8c7-9e62c1402228", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to mark as read" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a78f72a-a047-4abe-903e-ac0716855747", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to mark as read" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92bbbfc5-1e3d-40f7-8652-071544e7c560", "name": "List users assignable to conversations", "request": { "name": "List users assignable to conversations", "description": { "content": "Returns the list of team members of your company that can be assigned to a conversation. Use this to populate an assignee picker in your application before calling the assign endpoint. Each entry includes the user ID required as input by POST /conversations/{chatId}/assignee, the display name, and an optional avatar URL. Returns 401 if the API key is missing or invalid. Returns 502 if the upstream user-profile service is temporarily unavailable; this is a transient condition and the request can be safely retried after a short delay.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "assignable-users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d0d3268e-609f-4ed9-9cdc-4147465fb733", "name": "Assignable users retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "assignable-users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 4521,\n \"fullName\": \"Anna Bianchi\",\n \"profilePicture\": \"https://cdn.example.com/users/4521/avatar.png\"\n },\n {\n \"id\": 4521,\n \"fullName\": \"Anna Bianchi\",\n \"profilePicture\": \"https://cdn.example.com/users/4521/avatar.png\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ab9c57a-27c6-4a7c-af74-71faf2713c76", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "assignable-users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f738b8c-e1c7-445b-a277-4ce40e7cabbc", "name": "Upstream user-profile service temporarily unavailable", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", "assignable-users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed3511e3-e81b-437f-a37a-b625d3d59fb9", "name": "Get a single conversation", "request": { "name": "Get a single conversation", "description": { "content": "Returns the full metadata of one conversation, including its current assignee, unread counter, last message preview, and channel information. Use this to refresh details about a specific conversation without re-listing the whole inbox (for example after assigning or unassigning it). Returns 404 if the conversation does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a5fc0147-e305-45ca-beb4-d56ec91ad838", "name": "Conversation retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 500,\n \"companyId\": 1863,\n \"hasUnreadMessages\": true,\n \"lastCheckedAt\": \"2022-03-10\",\n \"userName\": \"string\",\n \"phoneNumber\": \"+39333123456\",\n \"profilePicture\": \"string\",\n \"unreadCount\": 1926,\n \"lastMessageText\": \"Thanks for your help!\",\n \"lastMessageDate\": \"2022-03-10\",\n \"socialMedia\": \"WHATSAPP\",\n \"companyProfileName\": \"string\",\n \"companyProfilePicture\": \"string\",\n \"companyProfileId\": \"string\",\n \"companyPhoneNumber\": \"string\",\n \"companyPhoneNumberType\": \"string\",\n \"whatsappWindowExpire\": \"2022-03-10\",\n \"assignedUserId\": 8730\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eb7c0a3-0659-4b4a-bda7-3eb79ecf1987", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0cd7e9b-6df5-421a-a235-12812d76911e", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7182a047-c5ff-4690-a764-603dd90304e7", "name": "Assign a conversation to a team member", "request": { "name": "Assign a conversation to a team member", "description": { "content": "Assigns the specified conversation to a user of your company. The assignee becomes the primary owner of the conversation and will receive notifications for new inbound messages on it. A conversation can have at most one assignee — calling this endpoint replaces any existing assignment. To remove the assignee without replacing it, use DELETE on the same resource. The user being assigned must belong to your company; cross-company assignment is not supported and results in a 404. Returns 400 if the request body is missing or `userId` is null. Returns 404 if the conversation or the target user does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"userId\": 4521\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "06f84feb-4712-431c-bba9-0ed98e0bcb28", "name": "Conversation successfully assigned", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": 4521\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fd354d0-28bb-4ffd-b9fc-6baf759a0d28", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": 4521\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c98f3f8c-62ad-4dd1-91c8-9687c062a2ad", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": 4521\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "229b029f-8901-4340-a6fb-fc3616ab5192", "name": "Conversation or user not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": 4521\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34eb2500-d96f-4f83-9d52-75b24d6d2a11", "name": "Remove the assignee from a conversation", "request": { "name": "Remove the assignee from a conversation", "description": { "content": "Clears the current assignee of the conversation, leaving it unassigned. The conversation itself remains active and continues to appear in the inbox; only the ownership link to a specific team member is removed. This operation is idempotent: calling it on a conversation that has no assignee succeeds and still returns 204. Returns 404 if the conversation does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e30dd575-32eb-45b2-953e-805be21302e7", "name": "Assignee removed", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44b532cc-63bc-4894-a8f0-24a5587f57a9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca35c2b7-4321-4f3c-8610-4d23865d2d0f", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "assignee" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0523ed6d-76fe-4d8f-bf05-0025eabf3a16", "name": "Unarchive a conversation", "request": { "name": "Unarchive a conversation", "description": { "content": "Restores a previously archived conversation, making it visible again in the default inbox view returned by GET /conversations. This reverses the effect of PATCH /conversations/{chatId}/archive. All messages remain intact; only the visibility flag is toggled. Returns 204 on success with no response body. Returns 404 if the conversation does not exist, does not belong to your account, or is not currently archived. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to unarchive" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3254a580-7d6e-4cdf-ab15-7667435e78d2", "name": "Conversation unarchived successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to unarchive" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "126b83c8-95e1-4bf9-89b0-36717982cf0e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to unarchive" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6201d9cd-57cc-4f65-9b72-ce5e5c3394d8", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "inbox", "conversations", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "chatId", "description": "(Required) ID of the conversation to unarchive" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f29f4ba7-f400-49b8-a6fc-cef196d1da35", "name": "Media", "description": { "content": "Upload and manage media files referenced in messages and campaigns.", "type": "text/plain" }, "item": [ { "id": "a8025a54-1b76-4ce8-afed-5b11ffd8a1ff", "name": "Upload a media file", "request": { "name": "Upload a media file", "description": { "content": "Uploads a new media file (image or video) to your media library. The request must use multipart/form-data encoding with the binary file in the 'file' part. Supported image formats include JPEG, PNG, and GIF. Supported video formats include MP4. Optionally provide a human-readable name and description for the file, and a folderId to organize it into a specific folder within your library. On success the response includes the newly created media ID. Store this ID and use it whenever you need to attach the file to an outbound message (e.g. RCS rich cards, WhatsApp media messages) or to campaign content. Returns 400 if the request is malformed, the file part is missing, or the file type is not supported. Returns 401 if the API key is missing or invalid. Returns 502 if the upstream media storage service is temporarily unavailable; retry after a short delay in this case.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "" }, { "key": "name", "value": "string", "type": "text", "description": "" }, { "key": "description", "value": "string", "type": "text", "description": "" }, { "key": "folderId", "value": "6513", "type": "text", "description": "" } ] } }, "response": [ { "id": "653cb659-eb0c-4ded-9e38-4c2c5f7fb882", "name": "Media uploaded successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "6513", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b22fe09-f18b-4e58-8204-ceac1d752c3b", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "6513", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "403bbf14-6ecc-47e2-aa35-3099a4e70ba9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "6513", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ce913a9-dc5b-4994-a536-743fe9595251", "name": "Upstream service error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "folderId", "value": "6513", "type": "text" } ] } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f7d8920-3bee-4037-bf80-fd478dcc5b9e", "name": "List company media", "request": { "name": "List company media", "description": { "content": "Returns a paginated list of all media files stored in your media library. Each entry contains the file ID, name, MIME type, size, and a URL for previewing or downloading the file. Use the id field from a result to reference that file when composing messages (for example, attaching an image to an RCS card or a WhatsApp media message) or when including media in campaign content. Pagination is controlled by page (0-based index) and limit (items per page, default 10, maximum 1000). Results can be sorted via sortBy (e.g. id, name) and sortOrder (asc or desc). Supported media types include common image formats (JPEG, PNG, GIF) and video formats (MP4). The exact set of accepted types depends on the downstream channel requirements. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "media" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "974", "description": "Maximum number of results per page. Defaults to 10." }, { "disabled": false, "key": "page", "value": "7225", "description": "Page number (0-based). Defaults to 0." }, { "disabled": false, "key": "sortBy", "value": "string", "description": "Field to sort by. Defaults to id." }, { "disabled": false, "key": "sortOrder", "value": "string", "description": "Sort order: asc or desc. Defaults to asc." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5cb5db85-91b1-4c64-aafb-db495b405311", "name": "Media list retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "513b9859-82b6-4efc-a191-8a2388be65e5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" }, { "key": "sortBy", "value": "string" }, { "key": "sortOrder", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "294a403a-ff14-4843-bdcd-bcb81c0f76b9", "name": "Get a media item", "request": { "name": "Get a media item", "description": { "content": "Returns the full metadata and access URL for a single media file identified by its numeric ID. The response includes the file name, MIME type, size in bytes, creation date, and a URL you can use to download or preview the file. This is useful when you need to verify the details of a media item before referencing it in a message or campaign. Returns 404 if no media file with the given ID exists in your library. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "media", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the media item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "868e4ae4-bbd9-481f-ae1c-da86468a8f6c", "name": "Media item retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the media item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 100,\n \"key\": \"string\",\n \"thumbnailKey\": \"string\",\n \"companyId\": 7218,\n \"userId\": 5798,\n \"name\": \"promo-banner\",\n \"description\": \"string\",\n \"filename\": \"banner.jpg\",\n \"size\": 524288,\n \"type\": \"string\",\n \"mimeType\": \"image/jpeg\",\n \"source\": 1076,\n \"folderId\": 8391,\n \"creationDate\": \"2022-03-10T12:15:50-04:00\",\n \"lastUpdateDate\": \"2022-03-10T12:15:50-04:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "653431a8-6788-4994-944a-f122fd52be4a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the media item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19be11ee-997e-4a36-b158-f45fdf1f44a6", "name": "Media not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the media item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b17cdeee-4b7a-4abd-88b8-f1a8ef84f06c", "name": "Delete a media item", "request": { "name": "Delete a media item", "description": { "content": "Permanently deletes a media file from your library. This action cannot be undone. Messages that have already been sent with this media are not affected because the media content was delivered at send time. However, any future message or campaign that references the deleted media ID will fail to resolve the file. Before deleting, make sure the media ID is not referenced in any scheduled campaign or message template that has not yet been sent. Returns 204 on success with no response body. Returns 404 if no media file with the given ID exists in your library. Returns 401 if the API key is missing or invalid.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "media", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the media item to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f6805515-5828-4bcc-9bbf-71fcb5c5a5de", "name": "Media deleted successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the media item to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "667d7a74-9cda-4401-befd-0ea8ef86fb93", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the media item to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a80de9f2-775f-4178-970b-b3ae432aa9e8", "name": "Media not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "media", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "id", "description": "(Required) ID of the media item to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7329da66-e328-4f93-9569-9e5319b77e6c", "name": "Message Delivery Status", "description": { "content": "Check the delivery status of one or more sent messages.", "type": "text/plain" }, "item": [ { "id": "a38a9470-a4cb-4fe4-8cd6-e655d9339e38", "name": "Get batch message delivery status", "request": { "name": "Get batch message delivery status", "description": { "content": "Returns the delivery status of multiple messages in a single call, which is significantly more efficient than calling the single-status endpoint in a loop. All IDs supplied in a single request must belong to the same channel (SMS, RCS, or WHATSAPP). If you need to check messages across different channels, make one batch request per channel. Supply the customerMessageId values as a comma-separated string in the ids query parameter (for example: ids=msg-001,msg-002,msg-003). Do not include spaces between IDs. While there is no strict hard limit on the number of IDs, it is recommended to keep each batch under a few hundred IDs to avoid excessively long query strings and potential HTTP 414 URI Too Long errors from intermediary proxies or load balancers. For very large lookups, split the IDs into multiple requests. The response is an unordered list of DeliveryStatusResponse objects. Important: IDs that do not match any known message for the authenticated company and specified channel are silently omitted from the results. This means the response array may contain fewer entries than the number of IDs you supplied. If none of the IDs match, you will receive an empty array (HTTP 200 with an empty JSON list), not a 404. To detect missing messages, compare the returned customerMessageId values against your original list. Each entry in the response contains the same fields as the single-status endpoint, including deliveryStatus (DELIVERED, SENT, RECEIVED, ERROR, EXPIRED, UNKNOWN) and deliveryStatusDescription for human-readable details. Error responses: 500 indicates an unexpected server-side error; retry the request after a short delay. For single-message lookups, use GET /partner-gateway/v1/messages/status/{customerMessageId} instead. For a full historical view with pagination and date filtering, see GET /partner-gateway/v1/messages/history.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "messages", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "channel", "value": "RCS", "description": "(Required) Messaging channel: RCS, WHATSAPP or SMS." }, { "disabled": false, "key": "ids", "value": "string", "description": "(Required) Comma-separated list of `customerMessageId` values returned at send time (e.g. `msg-001,msg-002,msg-003`)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bb6a2623-7c98-4e6e-a998-f6cff8217111", "name": "List of delivery status entries (may be empty if none found)", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "RCS" }, { "key": "ids", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"customerMessageId\": \"msg-001\",\n \"channel\": \"SMS\",\n \"destination\": \"+39333123456\",\n \"deliveryStatus\": \"DELIVERED\",\n \"deliveryStatusDescription\": \"Message delivered\",\n \"sendDate\": \"2025-03-10T14:30:00+01:00\",\n \"deliveryDate\": \"2025-03-10T14:30:05+01:00\",\n \"readDate\": null\n },\n {\n \"customerMessageId\": \"msg-002\",\n \"channel\": \"SMS\",\n \"destination\": \"+39333654321\",\n \"deliveryStatus\": \"ERROR\",\n \"deliveryStatusDescription\": \"Undeliverable\",\n \"sendDate\": \"2025-03-10T14:30:00+01:00\",\n \"deliveryDate\": null,\n \"readDate\": null\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e529f765-b8ad-4ab1-9d2e-00b98c148d7a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "RCS" }, { "key": "ids", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff22be36-6a59-4365-8714-c9639e73d0e1", "name": "Get single message delivery status", "request": { "name": "Get single message delivery status", "description": { "content": "Returns the current delivery status of a single message identified by its customerMessageId. The customerMessageId is the unique identifier that the platform assigns to your message when you send it through one of the send endpoints (POST /partner-gateway/v1/sms/messages, POST /partner-gateway/v1/rcs/messages, or POST /partner-gateway/v1/whatsapp/messages). You should store this identifier on your side immediately after a successful send call so that you can track the message lifecycle later. Typical workflow: (1) Send a message via the appropriate channel endpoint and receive the customerMessageId in the response. (2) Wait a reasonable amount of time for carrier processing (a few seconds for SMS, potentially longer for RCS and WhatsApp). (3) Call this endpoint with the customerMessageId and the matching channel to retrieve the current status. The channel query parameter is mandatory and must exactly match the channel used to send the message. Supplying a mismatched channel (for example, querying an SMS message with channel=RCS) will result in a 404 because the lookup is scoped to the specified channel. Possible delivery statuses and their meanings: SENT - the message has been accepted by the platform and forwarded to the carrier or channel provider, but no delivery confirmation has been received yet. DELIVERED - the carrier or channel provider confirmed that the message reached the recipient device. RECEIVED - the message was received by the downstream system but final delivery to the handset is not yet confirmed. ERROR - the message could not be delivered; check the deliveryStatusDescription field for the specific reason (common causes include invalid destination number, carrier rejection, or account suspension). EXPIRED - the message was not delivered within the allowed time-to-live window and the carrier discarded it. UNKNOWN - the platform has no status information for this message, which may indicate that the carrier did not return a delivery receipt or that the message is still being processed. Error responses: 404 is returned when the customerMessageId does not exist for the given channel and company, or when the channel parameter does not match the original send channel. 500 indicates an unexpected server-side error; retry the request after a short delay. For bulk status checks, use the batch endpoint GET /partner-gateway/v1/messages/status instead.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "messages", "status", ":customerMessageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "channel", "value": "RCS", "description": "(Required) Messaging channel: RCS, WHATSAPP or SMS." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "customerMessageId", "description": "(Required) The `customerMessageId` returned by the send endpoint when the message was created." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "21bb4782-8ed6-4199-a838-4f3f64ac19df", "name": "Delivery status found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "status", ":customerMessageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "RCS" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "customerMessageId", "description": "(Required) The `customerMessageId` returned by the send endpoint when the message was created." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"customerMessageId\": \"msg-sms-001\",\n \"channel\": \"SMS\",\n \"destination\": \"+39333123456\",\n \"deliveryStatus\": \"DELIVERED\",\n \"deliveryStatusDescription\": \"Message delivered to handset\",\n \"sendDate\": \"2025-03-10T14:30:00+01:00\",\n \"deliveryDate\": \"2025-03-10T14:30:05+01:00\",\n \"readDate\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1f05033-65f5-4710-95d8-d0c502fc2265", "name": "Message not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "status", ":customerMessageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "RCS" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "customerMessageId", "description": "(Required) The `customerMessageId` returned by the send endpoint when the message was created." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9ce9f6a-bd55-4193-9dc4-4ea345f0b5b4", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "status", ":customerMessageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "RCS" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "customerMessageId", "description": "(Required) The `customerMessageId` returned by the send endpoint when the message was created." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "58371bc0-b8ee-4362-8358-4aab74055df1", "name": "Message History", "description": { "content": "Browse and export the full history of sent messages.", "type": "text/plain" }, "item": [ { "id": "dbda413a-e3b6-4538-bf9f-3354df387719", "name": "List send history", "request": { "name": "List send history", "description": { "content": "Returns a paginated list of sent messages for the given channel and date range, allowing you to browse your complete sending history with flexible filtering. Use this endpoint when you need to review past sends, audit delivery performance over a time window, or build dashboards and reports on message delivery rates. The channel parameter is required and restricts results to a single messaging channel (SMS, RCS, or WHATSAPP). To retrieve history across multiple channels, make separate requests for each channel. The from and to parameters define the send-date range (inclusive on both ends) and are required. They must be valid ISO-8601 OffsetDateTime strings that include the timezone offset, for example: 2025-01-01T00:00:00+01:00 or 2025-06-15T23:59:59Z. Common formatting mistakes to avoid: omitting the timezone offset (2025-01-01T00:00:00 alone is not valid), using date-only strings without a time component, or using non-ISO separators. If from is after to, the result will be an empty list rather than an error. The optional status parameter lets you filter by a specific delivery status such as DELIVERED, SENT, ERROR, EXPIRED, or UNKNOWN. Omit this parameter to return messages in all statuses. Pagination is controlled by the page and limit parameters. Pages are 0-based (the first page is page=0). The default page size is 20 if limit is not specified. To iterate through all results, increment the page parameter until the response returns fewer items than the requested limit, which indicates you have reached the last page. The response is a JSON array of DeliveryStatusResponse objects, which may be empty if no messages match the given filters. For large date ranges with many messages, consider using the export endpoint (POST /partner-gateway/v1/messages/history/export) to generate a downloadable CSV file instead of paginating through thousands of results. Error responses: 500 indicates an unexpected server-side error; retry after a short delay.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "messages", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "channel", "value": "RCS", "description": "(Required) Messaging channel: RCS, WHATSAPP or SMS." }, { "disabled": false, "key": "from", "value": "2022-03-10T12:15:50-04:00", "description": "(Required) Start of the send-date range (ISO-8601 with offset)." }, { "disabled": false, "key": "limit", "value": "20", "description": "Page size." }, { "disabled": false, "key": "page", "value": "0", "description": "0-based page index." }, { "disabled": false, "key": "status", "value": "string", "description": "Optional delivery-status filter (e.g. DELIVERED, ERROR, EXPIRED, UNKNOWN)." }, { "disabled": false, "key": "to", "value": "2022-03-10T12:15:50-04:00", "description": "(Required) End of the send-date range (ISO-8601 with offset)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0e1152a2-fec6-48da-a026-313464d74930", "name": "List of sent messages (may be empty)", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "RCS" }, { "key": "from", "value": "2022-03-10T12:15:50-04:00" }, { "key": "limit", "value": "20" }, { "key": "page", "value": "0" }, { "key": "status", "value": "string" }, { "key": "to", "value": "2022-03-10T12:15:50-04:00" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"customerMessageId\": \"msg-sms-001\",\n \"channel\": \"SMS\",\n \"destination\": \"+39333123456\",\n \"deliveryStatus\": \"DELIVERED\",\n \"deliveryStatusDescription\": \"Message delivered\",\n \"sendDate\": \"2025-01-15T10:00:00+01:00\",\n \"deliveryDate\": \"2025-01-15T10:00:03+01:00\",\n \"readDate\": null\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e52d50-8760-4391-bce5-0edb16013e55", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "channel", "value": "RCS" }, { "key": "from", "value": "2022-03-10T12:15:50-04:00" }, { "key": "limit", "value": "20" }, { "key": "page", "value": "0" }, { "key": "status", "value": "string" }, { "key": "to", "value": "2022-03-10T12:15:50-04:00" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d42b15e9-ad11-4f4c-bff1-3f11eb8758bb", "name": "Export send history as CSV", "request": { "name": "Export send history as CSV", "description": { "content": "Queues an asynchronous CSV export of sent messages that were originated through the API within the given date range. This endpoint is designed for bulk data extraction and reporting scenarios where paginating through the list history endpoint would be impractical. The export covers all channels (SMS, RCS, WhatsApp) in a single file, so you do not need to request separate exports per channel. Only messages sent via the API are included; messages sent through other interfaces (such as campaign tools or the web console) are excluded. The request body requires startDateTime and endDateTime as ISO-8601 OffsetDateTime strings (for example: 2025-01-01T00:00:00+01:00). You can optionally filter by sender or recipient. This endpoint returns HTTP 202 Accepted immediately, meaning the export job has been queued but not yet completed. The export runs asynchronously in the background and may take from a few seconds to several minutes depending on the volume of data in the requested date range. To check the status of your export and retrieve the download URL once it is ready, poll the GET /partner-gateway/v1/exports endpoint. That endpoint will indicate whether the export is still in progress, completed (with a download link), or failed. The generated CSV file includes columns for message ID, channel, destination, delivery status, send date, delivery date, and other relevant metadata. Common pitfalls: requesting very large date ranges (months of data) may result in long processing times. If you need only a subset of the data, consider narrowing the date range or using the paginated list endpoint (GET /partner-gateway/v1/messages/history) instead. Error responses: 400 is returned if the request body is malformed or required fields are missing. 500 indicates an unexpected server-side error; retry after a short delay.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "messages", "history", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"startDateTime\": \"2025-01-01T00:00:00+01:00\",\n \"endDateTime\": \"2025-01-31T23:59:59+01:00\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23fd6e92-de77-4b93-9ce6-96fc9d1ae83d", "name": "Export job queued", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "history", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDateTime\": \"2025-01-01T00:00:00+01:00\",\n \"endDateTime\": \"2025-01-31T23:59:59+01:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c504402-ac54-40d7-98a8-0291126c3273", "name": "Invalid request", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "history", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDateTime\": \"2025-01-01T00:00:00+01:00\",\n \"endDateTime\": \"2025-01-31T23:59:59+01:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "117ced57-3822-46b3-9921-0c3368c2695c", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "messages", "history", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDateTime\": \"2025-01-01T00:00:00+01:00\",\n \"endDateTime\": \"2025-01-31T23:59:59+01:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6d68f4fd-65f8-45a0-a45b-f3692aed8e56", "name": "RCS", "description": { "content": "Send RCS messages and manage reusable templates.", "type": "text/plain" }, "item": [ { "id": "abc61aaf-8473-45fb-8de3-0a3cc7c2bab1", "name": "List RCS agents", "request": { "name": "List RCS agents", "description": { "content": "Returns the list of RCS Business Messaging agents for the authenticated company.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "974", "description": "Max results per page" }, { "disabled": false, "key": "page", "value": "7225", "description": "Page number (0-based)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "43d9b103-c580-41d4-91bc-e26f8f9d2502", "name": "Agents retrieved", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "221ac55e-9c1f-47a8-8978-306057c9ac63", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c37e96e0-99d0-4181-8798-916e582ebc27", "name": "Get a single RCS agent", "request": { "name": "Get a single RCS agent", "description": {}, "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "agents", ":agentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "agentId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7f115335-5666-45c4-9cff-1a183d89fdfc", "name": "Agent retrieved", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "agents", ":agentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "agentId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a96ca553-f250-4185-80a9-2d42deb1482d", "name": "Agent not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "agents", ":agentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "agentId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad6e7fd3-1d31-439c-a07e-ad1d572159bd", "name": "Get RCS message status", "request": { "name": "Get RCS message status", "description": { "content": "Returns the current delivery status of an RCS (Rich Communication Services) message identified by its messageId. Use this endpoint to track the lifecycle of a specific RCS message after it has been sent. The messageId is the identifier returned in the response when you originally sent the message through the RCS send endpoint. Store this identifier on your side at send time so you can poll for status later. RCS delivery statuses and their meanings: SENT - the message has been accepted by the platform and forwarded to the RCS carrier infrastructure, but delivery to the recipient device has not been confirmed yet. For RCS, this typically means the message is in transit through the Jibe or carrier RCS hub. DELIVERED - the RCS platform confirmed that the message was successfully delivered to the recipient device. This is a reliable delivery receipt provided by the RCS infrastructure, confirming the message arrived on the handset. Note that unlike WhatsApp, standard RCS does not provide a READ status through this API. RECEIVED - the message was acknowledged by the downstream RCS system but final delivery to the handset is not yet confirmed. This is an intermediate state that may appear briefly before transitioning to DELIVERED or ERROR. ERROR - the message could not be delivered. Common causes include: the recipient does not have an RCS-capable device or has RCS disabled, the carrier rejected the message, the agent ID is not properly registered, or the destination number is invalid. Consider implementing an SMS fallback strategy when RCS delivery fails. EXPIRED - the message exceeded its time-to-live window without being delivered and was discarded by the carrier. This can happen when the recipient device is offline for an extended period. UNKNOWN - no status information is available, either because the carrier did not return a delivery receipt or because the message is still being processed. RCS availability depends on carrier support and the recipient having an RCS-capable device with RCS enabled. If you need guaranteed delivery, consider pairing RCS sends with an SMS fallback by checking the status after a reasonable timeout and re-sending via SMS if the status is ERROR or EXPIRED. You can also query RCS message status through the generic delivery status endpoint GET /partner-gateway/v1/messages/status/{customerMessageId}?channel=RCS for a unified cross-channel experience. Error responses: 401 is returned if the API key is missing or invalid. 404 is returned if the messageId does not exist or does not belong to the authenticated company.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "messageId", "description": "(Required) ID of the RCS message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0703bdfa-1213-4a8d-b227-a0f944e5c1ef", "name": "Message status retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "messageId", "description": "(Required) ID of the RCS message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"messageId\": \"msg-rcs-001\",\n \"agentId\": \"42\",\n \"destination\": \"+39333123456\",\n \"status\": \"DELIVERED\",\n \"createdAt\": \"2025-03-10T14:30:00+01:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24c694da-12ef-4d4d-8feb-37344d3949d3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "messageId", "description": "(Required) ID of the RCS message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c7dfcb2-3052-44a9-bc4c-fe6bd6dedbb6", "name": "Message not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "rcs", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "messageId", "description": "(Required) ID of the RCS message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8d33d5de-3949-4372-aec4-efad7fcac46d", "name": "SMS", "description": { "content": "Send SMS text messages to any mobile phone number.", "type": "text/plain" }, "item": [ { "id": "123e9ebb-2f2a-4c32-a97a-e963b3ad4f89", "name": "List SMS senders", "request": { "name": "List SMS senders", "description": { "content": "Returns the list of SMS sender IDs (alphanumeric or numeric) for the authenticated company.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "sms", "senders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "974" }, { "disabled": false, "key": "page", "value": "7225" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "754fa5f9-bfc8-4ef1-b36b-52cf63e539b7", "name": "Senders retrieved", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "sms", "senders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c7e916a-7981-4d2e-965f-0d0c16d2a016", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "sms", "senders" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8ac7c9e3-78f2-4396-8174-7fcff7633de8", "name": "Social Profiles", "description": { "content": "Read the social profiles (Facebook Pages, Instagram, LinkedIn, …) connected to your account.", "type": "text/plain" }, "item": [ { "id": "685e683e-6ff4-4ec0-989d-ba093012fdb6", "name": "List connected social profiles", "request": { "name": "List connected social profiles", "description": { "content": "Returns all social media profiles currently connected to your account. A social profile represents an authenticated connection to an external platform such as Facebook, Instagram, LinkedIn, Google, or TikTok. Profiles are established through the platform's OAuth flow in the web dashboard and cannot be connected via this API. Each entry in the response includes the platform name, username, profile name, profile picture URL, connection date, a disconnected flag indicating whether the connection has become invalid, and a count of linked pages or sub-accounts. To get full details for a specific platform, including all linked pages and sub-accounts, call GET /socials/{platform} with the platform name (e.g. facebook, instagram, linkedin, google, tiktok). If a profile shows disconnected=true, the OAuth token has expired or been revoked and the connection must be re-established through the web dashboard. Returns 401 if the API key is missing or invalid. Returns 502 if the upstream profile service is temporarily unavailable.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partner-gateway", "socials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1a8091f0-47c8-4fc2-ae04-7b01f29edc25", "name": "Social profiles retrieved successfully", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "socials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"platform\": \"facebook\",\n \"username\": \"string\",\n \"profileName\": \"string\",\n \"profilePicture\": \"string\",\n \"connectionDate\": \"string\",\n \"disconnected\": true,\n \"pageCount\": 3766\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be265b4c-c672-446a-81bb-b364f31ce5dd", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "socials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc817674-57e9-41b0-ac7e-0666a83661cb", "name": "Upstream service error", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "socials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d696fe0-aa5e-4fe6-9bef-9193f1ada086", "name": "Get social profile detail", "request": { "name": "Get social profile detail", "description": { "content": "Returns the full details for a specific connected social platform, including all linked pages or sub-accounts (e.g. Facebook Pages managed by the connected Facebook profile). The platform path parameter is case-insensitive and must be one of: facebook, instagram, linkedin, google, tiktok. The response includes top-level profile information (username, profile name, picture, website, biography, link count, connection date, disconnected status) as well as a pages array. Each page entry contains the page ID, page name, profile picture, username, website, biography, link count, connection and expiration dates, and a disconnected flag. Use this endpoint when you need to enumerate all pages or sub-accounts available under a platform connection, for example to select which Facebook Page to publish content to. Returns 404 if no connected profile exists for the given platform name. This could mean the platform was never connected or has been removed. Returns 401 if the API key is missing or invalid. Returns 502 if the upstream profile service is temporarily unavailable.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partner-gateway", "socials", ":platform" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "platform", "description": "(Required) Platform identifier (facebook, instagram, linkedin, google, tiktok)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a68220e5-3353-486e-a4b8-020af6a14107", "name": "Social profile retrieved successfully", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "socials", ":platform" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "platform", "description": "(Required) Platform identifier (facebook, instagram, linkedin, google, tiktok)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"platform\": \"facebook\",\n \"username\": \"string\",\n \"profileName\": \"string\",\n \"profilePicture\": \"string\",\n \"website\": \"string\",\n \"biography\": \"string\",\n \"linksCount\": 8362,\n \"connectionDate\": \"string\",\n \"disconnected\": false,\n \"pages\": [\n {\n \"pageId\": \"string\",\n \"pageName\": \"string\",\n \"profilePicture\": \"string\",\n \"username\": \"string\",\n \"website\": \"string\",\n \"biography\": \"string\",\n \"linksCount\": 4563,\n \"connectionDate\": \"string\",\n \"expireDate\": \"string\",\n \"disconnected\": true\n },\n {\n \"pageId\": \"string\",\n \"pageName\": \"string\",\n \"profilePicture\": \"string\",\n \"username\": \"string\",\n \"website\": \"string\",\n \"biography\": \"string\",\n \"linksCount\": 7269,\n \"connectionDate\": \"string\",\n \"expireDate\": \"string\",\n \"disconnected\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "787c37fa-e32f-483e-8d4f-d4d510c48765", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "socials", ":platform" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "platform", "description": "(Required) Platform identifier (facebook, instagram, linkedin, google, tiktok)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b49d1505-2962-4e63-ab20-60357d45a23c", "name": "No connected profile found for the given platform", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "socials", ":platform" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "platform", "description": "(Required) Platform identifier (facebook, instagram, linkedin, google, tiktok)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fe064e9-46e5-47b4-b8e1-a0fad993eef9", "name": "Upstream service error", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "socials", ":platform" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "platform", "description": "(Required) Platform identifier (facebook, instagram, linkedin, google, tiktok)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b62948b1-c60f-4af2-812a-171d22986427", "name": "Subscription", "description": { "content": "Read your active subscription plan and remaining quotas.", "type": "text/plain" }, "item": [ { "id": "3eaa9e70-6a7d-4f9d-88c0-74b52a63e7f6", "name": "Get active subscription", "request": { "name": "Get active subscription", "description": { "content": "Returns the currently active subscription plan for your account. The response includes the plan code (e.g. PRO_MONTHLY, STARTER_YEARLY), the status (ACTIVE, CANCELED, SUSPENDED), the current billing period start and end dates, the next renewal date, whether the subscription has been canceled, and the next plan code if a plan change is scheduled. Use this endpoint to programmatically check your plan tier before making API calls that may be restricted by plan level, or to display subscription information in your own dashboard. The billing period dates define the current invoicing cycle. The nextRenew date indicates when the subscription will automatically renew (unless canceled). If canceled is true but status is still ACTIVE, the plan remains usable until the end of the current billing period, after which it will not renew. Returns 401 if the API key is missing or invalid. Returns 404 if no active subscription exists for your account. Returns 502 if the upstream subscription service is temporarily unavailable.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partner-gateway", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ee4fa500-853d-49c5-98d1-79803886d3a2", "name": "Active subscription retrieved successfully", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"planCode\": \"PRO_MONTHLY\",\n \"status\": \"ACTIVE\",\n \"billingPeriodStart\": \"2025-03-01T00:00:00+01:00\",\n \"billingPeriodEnd\": \"2025-03-31T23:59:59+01:00\",\n \"nextRenew\": \"2025-04-01T00:00:00+01:00\",\n \"canceled\": false,\n \"nextPlan\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e73ac7c6-bd82-4593-95fb-c0396859aec0", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51caa91d-41e0-4461-b386-b0620ee16d99", "name": "No active subscription found", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97fffd05-9deb-47d2-bcc3-d59bf452144e", "name": "Upstream service error", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96f65575-d8de-43d1-b3fb-301b3f5e722e", "name": "Get contact quota usage", "request": { "name": "Get contact quota usage", "description": { "content": "Returns the contact storage quota for your account, broken down into plan limit, extra limit, total limit, used count, and remaining capacity. The planLimit is the number of contacts included in your subscription plan. The extraLimit is any additional contact capacity you have purchased on top of your plan. The totalLimit is the sum of both. The used field indicates how many contacts are currently stored in your account, and remaining is the number of new contacts you can still add before reaching your quota. Monitor this endpoint before performing bulk contact imports to ensure you have sufficient capacity. If remaining reaches zero, attempts to create new contacts will be rejected. To increase your quota, upgrade your subscription plan or purchase additional contact capacity through the billing dashboard. Returns 401 if the API key is missing or invalid. Returns 404 if no active subscription exists for your account. Returns 502 if the upstream subscription service is temporarily unavailable.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6cef27d5-ee38-4b9e-bc2e-535159a4f524", "name": "Contact quota retrieved successfully", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"planLimit\": 10000,\n \"extraLimit\": 5000,\n \"totalLimit\": 15000,\n \"used\": 8342,\n \"remaining\": 6658\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5d3b3ac-7529-41bc-adaf-012ffc724ca9", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f39bc05-e238-4f59-a1d0-875c6a0d4d4a", "name": "No active subscription found", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1d52b3c-b372-425b-be92-8bba28d13069", "name": "Upstream service error", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42306f3e-0097-404b-b684-79ee2320ba85", "name": "Get credit balance", "request": { "name": "Get credit balance", "description": { "content": "Returns the credit balance for your account, split into three values: total credit, frozen credit, and available credit. Credit is the currency used to pay for message sending and other billable operations on the platform. The credit field is your total credit balance. The frozenCredit field represents credit that has been reserved (frozen) for pending operations such as scheduled campaigns that have been queued but not yet fully delivered. Frozen credit cannot be spent on new operations until the pending operations complete or are canceled. The availableCredit field is the amount you can actually spend right now (credit minus frozenCredit). Check this endpoint before launching large campaigns to ensure you have enough available credit to cover the estimated cost. If available credit is insufficient, the campaign or message send may be rejected. Credit can be topped up through the billing dashboard or via your account manager. Returns 401 if the API key is missing or invalid. Returns 502 if the upstream wallet service is temporarily unavailable.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "14ddf2a6-4d24-4c0c-af06-8d6ad6539e0c", "name": "Credit balance retrieved successfully", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"credit\": 50000,\n \"frozenCredit\": 5000,\n \"availableCredit\": 45000\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b78ca4b-33b1-4dae-b03e-8bacffe9cc1d", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f89f8ac0-9a22-4929-bf02-c008a2271fd4", "name": "Upstream service error", "originalRequest": { "url": { "path": [ "api", "v1", "partner-gateway", "subscription", "credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d092e60d-e578-42bf-a4eb-9690f7bae982", "name": "Webhooks", "description": { "content": "Configure an HTTPS callback URL to receive real-time delivery-status notifications.", "type": "text/plain" }, "item": [ { "id": "f7418d82-6390-4913-8b71-7ddd628096db", "name": "Update delivery-status webhook", "request": { "name": "Update delivery-status webhook", "description": { "content": "Replaces the callback URL of the existing delivery-status webhook with a new URL. Use this when your server endpoint changes and you want to redirect notifications without any downtime. The update takes effect immediately: subsequent delivery-status events will be sent to the new URL. The new callback URL must use HTTPS. This endpoint does not create a webhook if none exists. If no webhook is currently configured, a 404 is returned; use POST /webhooks/delivery-status to create one first. Returns 400 if the request body is invalid (e.g. missing or malformed callbackUrl). Returns 401 if the API key is missing or invalid. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status-v2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f0f3f381-15ea-471c-924e-662246b1dd18", "name": "Webhook updated successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status-v2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"companyId\": 1,\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status-v2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "304699b4-6605-4866-8cb8-23fb32c31b08", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status-v2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05a0e0a6-9e39-4a47-baa3-af14581b5e40", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status-v2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7d85c7f-e6d1-418f-a30e-1ead96a98a26", "name": "No webhook configured", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status-v2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bc5f849-c05f-4cfe-a435-9014ef6483bc", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status-v2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2f98bd4-9add-45e2-81ef-aae658f342f4", "name": "Revoke delivery-status webhook", "request": { "name": "Revoke delivery-status webhook", "description": { "content": "Permanently removes the configured delivery-status webhook. After deletion, no further delivery-status notifications will be sent to the previously configured URL. The change takes effect immediately. If you need to receive notifications again in the future, you must create a new webhook using POST /webhooks/delivery-status. Any in-flight notification requests that were already dispatched before the deletion may still arrive at the old URL; this is expected and does not indicate an error. Returns 204 on success with no response body. Returns 404 if no webhook is currently configured. Returns 401 if the API key is missing or invalid. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f6a57048-3900-4e42-802f-ea64b024510a", "name": "Webhook revoked successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de35616c-a021-40b2-95eb-95867aecdc18", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc123ea7-c391-4271-b94b-5dea182e33c7", "name": "No webhook configured", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e510f81-2800-46ce-8a51-cceecf0c9d8e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11e9a4fe-d8ff-454d-b9bb-b91e246551bc", "name": "Get delivery-status webhook", "request": { "name": "Get delivery-status webhook", "description": { "content": "Returns the HTTPS callback URL currently configured to receive real-time delivery-status notifications for your account. The platform sends an HTTP POST to this URL every time a delivery-status event occurs for any message sent through your account, across all channels (SMS, RCS, WhatsApp). The same callback URL is shared across all channels; you do not configure separate URLs per channel. Use this endpoint to verify your current webhook configuration before updating or troubleshooting delivery-status callbacks. Returns 404 if no webhook has been configured yet. To set one up, use POST /webhooks/delivery-status. Returns 401 if the API key is missing or invalid. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d022d7c5-3569-4693-b1f4-8adc9de08e8c", "name": "Webhook configuration retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"companyId\": 1,\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddb43bb9-b9c6-40e0-8205-dfd1e96231d0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a43331cd-efe0-4969-9ebf-d5aaa8218604", "name": "No webhook configured", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05955f53-3eba-42e1-802d-bbf48ccbe59a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e962d618-1fd8-4860-b82f-edd592190d5e", "name": "Configure delivery-status webhook", "request": { "name": "Configure delivery-status webhook", "description": { "content": "Registers an HTTPS callback URL to receive real-time delivery-status notifications. Once configured, the platform will send an HTTP POST request to your callback URL every time a delivery-status event occurs for messages sent through your account. Events include statuses such as delivered, read, failed, and other channel-specific states across SMS, RCS, and WhatsApp. The callback URL must use HTTPS. The payload is a JSON object containing the message ID, channel, status, timestamp, and any error details. Your server must respond with a 2xx status code within a reasonable timeout to acknowledge receipt. If your endpoint is unreachable or returns an error, the platform may retry the notification a limited number of times before giving up. Only one webhook URL can be active per account. If a webhook is already configured, this endpoint returns 409 Conflict. In that case, use PUT /webhooks/delivery-status to update the existing URL, or DELETE /webhooks/delivery-status to remove it first. Returns 400 if the request body is invalid (e.g. missing or malformed callbackUrl). Returns 401 if the API key is missing or invalid. Returns 500 if an internal error occurs.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e89cdcbd-8630-451d-bc69-0b3dc1aaf55e", "name": "Webhook configured successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"companyId\": 1,\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0466456a-e741-40d9-b83a-b979eb8eebe4", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ee7273c-1538-40b5-bda7-3e98930dcae7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbe28f26-3f46-47ae-bbf3-cfbeb1651e18", "name": "Webhook already configured", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3b57be9-1291-4b33-8283-200781daacf4", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "webhooks", "delivery-status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-server.example.com/webhooks/delivery-status\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "911dc479-4c6b-4e43-a8ae-195ebe3b571d", "name": "WhatsApp", "description": { "content": "Send WhatsApp Business messages and manage templates.", "type": "text/plain" }, "item": [ { "id": "41a30f4c-a6f8-4407-b926-6b35df87f100", "name": "Get WhatsApp message status", "request": { "name": "Get WhatsApp message status", "description": { "content": "Returns the current delivery status of a WhatsApp Business message identified by its messageId. Use this endpoint to track the full lifecycle of a WhatsApp message after it has been sent, including whether the recipient has read it. The messageId is the identifier returned in the response when you originally sent the message through the WhatsApp send endpoint. Store this identifier on your side at send time so you can poll for status later. WhatsApp delivery statuses and their meanings: SENT - the message has been accepted by the platform and forwarded to the WhatsApp Business API infrastructure. At this point the message is in transit to the WhatsApp servers but has not yet been delivered to the recipient device. This corresponds to a single grey checkmark in the WhatsApp UI. DELIVERED - the WhatsApp servers confirmed that the message was delivered to the recipient device. This corresponds to double grey checkmarks in the WhatsApp UI. The recipient may not have opened the conversation yet. READ - the recipient has opened the conversation and viewed the message. This corresponds to double blue checkmarks in the WhatsApp UI. This status is unique to WhatsApp among the supported channels and provides valuable engagement insight. Note that recipients can disable read receipts in their WhatsApp privacy settings, in which case the status will remain at DELIVERED even after the message has been read. RECEIVED - the message was acknowledged by the WhatsApp system but final delivery to the handset is not yet confirmed. This is an intermediate state. ERROR - the message could not be delivered. Common causes include: the recipient phone number is not registered on WhatsApp, the WhatsApp Business account has been restricted or banned, the message template was rejected, the 24-hour customer service window has expired (for non-template messages), or the destination number is invalid. Check the response details for the specific error reason. EXPIRED - the message was not delivered within the allowed time window and was discarded. This can happen when the recipient device is offline for an extended period. UNKNOWN - no status information is available from WhatsApp, which may indicate the message is still being processed or that the status callback was not received. WhatsApp-specific considerations: WhatsApp enforces a 24-hour customer service window. Outside this window, you can only send pre-approved template messages. Sending a non-template message outside the window will result in an ERROR status. Also, WhatsApp has rate limits and quality ratings that can affect delivery. You can also query WhatsApp message status through the generic delivery status endpoint GET /partner-gateway/v1/messages/status/{customerMessageId}?channel=WHATSAPP for a unified cross-channel experience. Error responses: 401 is returned if the API key is missing or invalid. 404 is returned if the messageId does not exist or does not belong to the authenticated company.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "messageId", "description": "(Required) ID of the WhatsApp message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1249876a-76f7-4d36-bd13-8c9e8e17a7e9", "name": "Message status retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "messageId", "description": "(Required) ID of the WhatsApp message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"messageId\": \"msg-wa-001\",\n \"phoneNumberId\": 12,\n \"destination\": \"+39333123456\",\n \"status\": \"DELIVERED\",\n \"createdAt\": \"2025-03-10T14:30:00+01:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ad56d2f-a1bb-4649-8f30-8f009727983c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "messageId", "description": "(Required) ID of the WhatsApp message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "883e9de2-8f4e-41f6-a16d-442f621ea24a", "name": "Message not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "messageId", "description": "(Required) ID of the WhatsApp message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9356b46-2640-4b82-8ee3-23638ac2a1d7", "name": "List WhatsApp phone numbers", "request": { "name": "List WhatsApp phone numbers", "description": { "content": "Returns a paginated list of WhatsApp Business phone numbers associated with the authenticated company.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "974", "description": "Maximum number of results per page. Defaults to 10." }, { "disabled": false, "key": "page", "value": "7225", "description": "Page number (0-based). Defaults to 0." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8563dd99-3145-4d57-82f4-24fc1ac08414", "name": "Phone numbers retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0fc7520-3c01-464d-b545-ba55ac190fb2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "phone-numbers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "974" }, { "key": "page", "value": "7225" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bcaa069-7eab-4491-9274-08dad8b1e303", "name": "Get a WhatsApp phone number", "request": { "name": "Get a WhatsApp phone number", "description": { "content": "Retrieves a single WhatsApp Business phone number by its ID.", "type": "text/plain" }, "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "phone-numbers", ":phoneNumberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "phoneNumberId", "description": "(Required) ID of the WhatsApp phone number" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e04889ed-5a2a-42f9-8283-95084d5df314", "name": "Phone number retrieved successfully", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "phone-numbers", ":phoneNumberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "phoneNumberId", "description": "(Required) ID of the WhatsApp phone number" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e47c146b-b222-45e0-8402-10632dcd9ab6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "phone-numbers", ":phoneNumberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "phoneNumberId", "description": "(Required) ID of the WhatsApp phone number" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e8ad9d-53ef-4d84-89b5-4f81278c5621", "name": "Phone number not found", "originalRequest": { "url": { "path": [ "api", "partner-gateway", "v1", "whatsapp", "phone-numbers", ":phoneNumberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7621", "key": "phoneNumberId", "description": "(Required) ID of the WhatsApp phone number" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://lora-api.agiletelecom.com", "type": "string" }, { "key": "apiKey", "value": "YOUR_API_KEY", "type": "string" } ], "info": { "_postman_id": "ced48752-89ef-4864-acdb-b2207720ff09", "name": "Qlara Platform API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## Overview\n\nThe **Qlara Platform API** is a unified REST interface that lets you:\n\n- **Track delivery** of messages sent via SMS, RCS, and WhatsApp — poll per-message status or configure a webhook\n- **Manage contacts and lists** used as campaign targets\n- **Create and manage bulk campaigns** across SMS, RCS, and WhatsApp channels\n- **Browse and export** the full history of sent messages\n- **Handle two-way conversations** through the inbox\n- **Upload media** (images, videos) reused across campaigns and conversations\n- **Connect social profiles** (Facebook, Instagram, LinkedIn, Google, TikTok)\n\n> **Note:** Message sending (SMS, RCS, WhatsApp) is handled by separate upstream services.\n> This API provides delivery tracking, campaign management, contact management, and conversation handling.\n\n---\n\n## Authentication\n\nEvery request must include a valid API key in the **`X-API-Key`** HTTP header:\n\n```\nX-API-Key: \n```\n\nAPI keys are scoped to your account. Use the **API Keys** section to create and manage them.\n\n---\n\n## Supported Channels\n\n| Channel | Key | Available Operations |\n|---------|-----|---------------------|\n| SMS | `SMS` | Delivery tracking, history, campaigns |\n| RCS | `RCS` | Delivery tracking, history, campaigns |\n| WhatsApp | `WHATSAPP` | Delivery tracking, history, campaigns |\n\n---\n\n## Core Workflows\n\n### 1 — Track message delivery status\n```\nGET /partner-gateway/v1/messages/status/{customerMessageId}?channel=SMS\n -> 200 { deliveryStatus: \"DELIVERED\" }\n```\nYou can also query RCS and WhatsApp message statuses through their dedicated endpoints.\n\n### 2 — Receive delivery events via webhook (no polling)\n```\nPOST /partner-gateway/v1/webhooks/delivery-status\n { \"callbackUrl\": \"https://your-server.example.com/webhook\" }\n```\nThe platform will POST delivery events to that URL automatically.\n\n### 3 — Run a bulk campaign\n```\nPOST /partner-gateway/v1/campaigns -> create campaign (draft)\nPUT /partner-gateway/v1/campaigns/{id}/confirm -> schedule & send\nGET /partner-gateway/v1/campaigns/stats -> delivery statistics\n```\n\n### 4 — Export message history\n```\nPOST /partner-gateway/v1/messages/history/export -> 202 Accepted\nGET /partner-gateway/v1/exports -> poll until isAvailableForDownload = true\nGET /partner-gateway/v1/exports/{exportId} -> retrieve download URL\n```\n\n---\n\n## Asynchronous Operations\n\nOperations that may take a long time (campaign sending, data exports) return\n**`202 Accepted`** immediately and process in the background.\nUse the corresponding list or status endpoint to monitor progress.\n\n---\n\n## Common HTTP Status Codes\n\n| Code | Meaning |\n|------|---------|\n| 200 | OK — request succeeded |\n| 201 | Created — resource created successfully |\n| 202 | Accepted — asynchronous job queued |\n| 204 | No Content — operation succeeded with no response body |\n| 400 | Bad Request — validation error; inspect the response body for details |\n| 401 | Unauthorized — missing or invalid `X-API-Key` |\n| 404 | Not Found — the requested resource does not exist |\n| 409 | Conflict — the resource already exists (e.g. a webhook is already configured) |\n| 500 | Internal Server Error |\n| 502 | Bad Gateway — upstream channel provider returned an error |", "type": "text/plain" } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] } }