{ "info": { "_postman_id": "6f1d2c3a-8b47-4e59-9a10-3c7e5d2f8b41", "name": "Easify API", "description": "The Easify REST API. Full documentation: https://easify.app/docs/api/getting-started/introduction\n\n**Before your first request**\n\n1. Set the `api_token` collection variable to your API token, from Settings > API Settings in the Easify app.\n2. Add your public IP address to your API whitelist, or requests return 400 \"Access denied\".\n\n**These requests are real.** They send messages, spend credits and change or delete data. Replace the sample values, including those masked with `*`, before you press Send.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "SMS", "item": [ { "name": "Send SMS (New)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/sms/send", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "sms", "send" ] }, "body": { "mode": "raw", "raw": "{\n \"from_number\": \"315293****\",\n \"to_number\": \"315135****\",\n \"country_code\": \"+1\",\n \"message\": \"Hi Alex, this is ABC Company. Your appointment is confirmed for Tue, Nov 18 at 10:00 AM. Reply STOP to unsubscribe.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint is used to send SMS/MMS with a higher rate limit of 10000 requests a minute.\n\nDocumentation: https://easify.app/docs/api/sms-v3/sms-send" }, "response": [] }, { "name": "Send SMS (Classic)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sms/send", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sms", "send" ] }, "body": { "mode": "raw", "raw": "{\n \"from_number\": \"+1315293****\",\n \"to_number\": \"315135****\",\n \"country_code\": \"+1\",\n \"message\": \"Hi Alex, this is ABC Company. Your appointment is confirmed for Tue, Nov 18 at 10:00 AM. Reply STOP to unsubscribe.\",\n \"check_blacklist\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint is used to send SMS/MMS with a rate limit of 1000 requests a minute.\n\nDocumentation: https://easify.app/docs/api/sms/sms-send" }, "response": [] }, { "name": "SMS Status (New)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/sms/status?reference_id=41a66ba9-3e50-481a-8cc4-db7**", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "sms", "status" ], "query": [ { "key": "reference_id", "value": "41a66ba9-3e50-481a-8cc4-db7**", "description": "reference_id is provided in the send-sms API response" } ] }, "description": "This endpoint is used to fetch the status of a message sent with [Send SMS (New)](/docs/api/sms-v3/sms-send).\n\nDocumentation: https://easify.app/docs/api/sms-v3/sms-status" }, "response": [] }, { "name": "SMS Status (Classic)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sms/status?sms_id=3315**", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sms", "status" ], "query": [ { "key": "sms_id", "value": "3315**", "description": "sms_id is provided in the send-sms API response" } ] }, "description": "This endpoint is used to fetch the status of a message sent with [Send SMS (Classic)](/docs/api/sms/sms-send).\n\nDocumentation: https://easify.app/docs/api/sms/sms-status" }, "response": [] }, { "name": "SMS Chat History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sms/chat-history?sender=%2B1315293****&receiver=315135****&country_code=%2B1&limit=1", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sms", "chat-history" ], "query": [ { "key": "sender", "value": "%2B1315293****", "description": "Sender Number (The user's sender number associated with the API token)" }, { "key": "receiver", "value": "315135****", "description": "Receiver Number(To fetch the SMS, use the receiver's number without the country code. For the country code,use the 'country_code' field and enter the appropriate country code.)" }, { "key": "country_code", "value": "%2B1", "description": "Receiver's Country Code (e.g., +1, +972)" }, { "key": "limit", "value": "1", "description": "Pagination Limit (Default :10, Max: 50)" } ] }, "description": "This endpoint is used to retrieve SMS/Chat History.\n\nDocumentation: https://easify.app/docs/api/sms/sms-chat-history" }, "response": [] }, { "name": "SMS Report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sms/report?from_date=2024-10-01&to_date=2024-10-30&limit=2&status=Success&sender=%2B1315444****&receiver=313451****&order=desc&page=2&country_code=%2B1", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sms", "report" ], "query": [ { "key": "from_date", "value": "2024-10-01", "description": "The start date of the time frame for fetching data. This should be provided in the YYYY-MM-DD format." }, { "key": "to_date", "value": "2024-10-30", "description": "The end date of the time frame for fetching data. This should be provided in the YYYY-MM-DD format." }, { "key": "limit", "value": "2", "description": "Pagination for SMS Report data (Default :10, Maximum: 100)" }, { "key": "status", "value": "Success", "description": "Filters the data based on the specified status(Pending, Success, Delivered, Undelivered,Failed, Scheduled)" }, { "key": "sender", "value": "%2B1315444****", "description": "Filters the data based on the sender's phone number(Sender number associated with the API token.)" }, { "key": "receiver", "value": "313451****", "description": "Filters the data based on the receiver's phone number Note: If the receiver field is provided, the country_code field must be provided" }, { "key": "order", "value": "desc", "description": "Specifies the order in which the data should be sorted. Use asc for ascending order and desc for descending order; the default is desc" }, { "key": "page", "value": "2", "description": "The page number for paginated data" }, { "key": "country_code", "value": "%2B1", "description": "Receiver’s country code ( eg: +1, +972 ) Note: If the country code is provided, the receiver field must be provided." } ] }, "description": "This endpoint is used to retrieve user's sms reports.\n\nDocumentation: https://easify.app/docs/api/sms/sms-report" }, "response": [] }, { "name": "SMS Templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sms/templates?limit=2", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sms", "templates" ], "query": [ { "key": "limit", "value": "2", "description": "Pagination for SMS Templates (Default :10, Max: 50)" } ] }, "description": "Documentation: https://easify.app/docs/api/sms/templates" }, "response": [] }, { "name": "SMS Campaign", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sms/campaign/send", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sms", "campaign", "send" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "campaign_name", "value": "New Campaign", "type": "text", "description": "Name for the Campaign", "disabled": false }, { "key": "from_numbers[]", "value": "+17473194***", "type": "text", "description": "From number(s) to send Campaign *Ensure that you are using a phone number associated with the api token, please use the Phone Numbers API to retrieve the associated phone numbers. *Include the country code (e.g., +17473194***). A missing + is added, but a country code is not, so a 10-digit number is rejected. *Every number must be active, approved, assigned to the API token's user and allowed for campaigns. If any number fails this check, the whole request is rejected." }, { "key": "from_numbers[]", "value": "+19598000***", "type": "text", "description": "From number(s) to send Campaign *Ensure that you are using a phone number associated with the api token, please use the Phone Numbers API to retrieve the associated phone numbers. *Include the country code (e.g., +17473194***). A missing + is added, but a country code is not, so a 10-digit number is rejected. *Every number must be active, approved, assigned to the API token's user and allowed for campaigns. If any number fails this check, the whole request is rejected." }, { "key": "template_ids[]", "value": "1457", "type": "text", "description": "Templates IDs to send campaign *Use the SMS Templates API to retrieve the available templates and obtain their IDs." }, { "key": "template_ids[]", "value": "1448", "type": "text", "description": "Templates IDs to send campaign *Use the SMS Templates API to retrieve the available templates and obtain their IDs." }, { "key": "recipients_file", "type": "file", "src": [], "description": "Recipients' data (The file must be in CSV format)" }, { "key": "schedule_time", "value": "", "type": "text", "description": "Campaign Schedule time, in the schedule_timezone Must be in the format YYYY-MM-DD HH:MM:SS (e.g., 2025-08-28 06:01:58). Any other format returns a 400 error.", "disabled": true }, { "key": "schedule_timezone", "value": "", "type": "text", "description": "Timezone for the scheduled campaign, using IANA format (e.g., America/New_York). An unknown timezone returns a 400 error.", "disabled": false } ] }, "description": "This endpoint is used to send SMS campaigns using predefined SMS templates.\n\nDocumentation: https://easify.app/docs/api/sms-campaign/sms-campaign-send" }, "response": [] }, { "name": "SMS Campaign Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sms/campaign/status?campaign_id=313", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sms", "campaign", "status" ], "query": [ { "key": "campaign_id", "value": "313", "description": "Unique identifier for the campaign. Returned in the response of the SMS Campaign Send API." } ] }, "description": "This endpoint is used to fetch sms campaign status.\n\nDocumentation: https://easify.app/docs/api/sms-campaign/sms-campaign-status" }, "response": [] }, { "name": "SMS Campaign Items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sms/campaign/items?campaign_id=313&limit=2", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sms", "campaign", "items" ], "query": [ { "key": "campaign_id", "value": "313", "description": "Unique identifier for the campaign. Returned in the response of the Send SMS Campaign API" }, { "key": "limit", "value": "2", "description": "Pagination limit for the data (Default :10, Max: 50)" } ] }, "description": "This endpoint is used to fetch all SMS items within a campaign.\n\nDocumentation: https://easify.app/docs/api/sms-campaign/sms-campaign-items" }, "response": [] } ] }, { "name": "Email", "item": [ { "name": "List Email Senders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/email/senders?limit=10", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "email", "senders" ], "query": [ { "key": "limit", "value": "10", "description": "Number of senders per page (Min :1, Max :50). If not sent, all senders are returned without pagination" }, { "key": "page", "value": "", "description": "Specific page number for paginated data", "disabled": true } ] }, "description": "This endpoint is used to retrieve user's email senders.\n\nDocumentation: https://easify.app/docs/api/email/email-senders" }, "response": [] }, { "name": "Send Single-Recipient Email", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/email/send", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "email", "send" ] }, "body": { "mode": "raw", "raw": "{\n \"sender\": \"appointments@example.com\",\n \"receiver\": \"alex@example.com\",\n \"subject\": \"Your appointment is confirmed\",\n \"message\": \"

Hi Alex,

Your appointment with ABC Company is confirmed for Tuesday, November 18 at 10:00 AM.

ABC Company, 123 Main Street, Springfield, IL 62701

\",\n \"from_name\": \"ABC Company\",\n \"enable_unsubscribe\": 1,\n \"additional_data\": {\n \"name\": \"Alex\",\n \"id\": \"232\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint is used to send email from easify.\n\nDocumentation: https://easify.app/docs/api/email/email-send" }, "response": [] }, { "name": "Send Multi-Recipient Email", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/email/send", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "email", "send" ] }, "body": { "mode": "raw", "raw": "{\n \"sender\": \"news@example.com\",\n \"receiver\": [\n \"alex@example.com\",\n \"jordan@example.com\"\n ],\n \"cc\": [\n \"frontdesk@example.com\"\n ],\n \"bcc\": [\n \"records@example.com\"\n ],\n \"subject\": \"Holiday hours at ABC Company\",\n \"message\": \"

Hello,

ABC Company will be closed on Thursday, November 27. We reopen on Friday, November 28 at 8:00 AM.

ABC Company, 123 Main Street, Springfield, IL 62701

To stop receiving these emails, visit example.com/unsubscribe.

\",\n \"from_name\": \"ABC Company\",\n \"additional_data\": {\n \"name\": \"Alex\",\n \"id\": \"232\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint allows sending emails from Easify, supporting multiple recipients, CC, and BCC.\n\nDocumentation: https://easify.app/docs/api/email-v3/email-send" }, "response": [] }, { "name": "Single-Recipient Email Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/email/status?email_id=6746c18a3b67fc3da50e****", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "email", "status" ], "query": [ { "key": "email_id", "value": "6746c18a3b67fc3da50e****", "description": "email_id is provided in the send-email API response" } ] }, "description": "This endpoint is used to retrieve email status.\n\nDocumentation: https://easify.app/docs/api/email/email-status" }, "response": [] }, { "name": "Multi-Recipient Email Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/email/status?email_id=675", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "email", "status" ], "query": [ { "key": "email_id", "value": "675", "description": "email_id is provided in the email/send API response" }, { "key": "receiver", "value": "", "description": "Receiver email address to fetch the status of a particular receiver", "disabled": true } ] }, "description": "This endpoint is used to retrieve email status.\n\nDocumentation: https://easify.app/docs/api/email-v3/email-status" }, "response": [] } ] }, { "name": "Phone Numbers", "item": [ { "name": "List Phone Numbers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/phone-numbers?limit=10", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "phone-numbers" ], "query": [ { "key": "limit", "value": "10", "description": "Pagination for phone numbers (Max: 50)" } ] }, "description": "This endpoint is used to retrieve the user's active and approved phone numbers.\n\nDocumentation: https://easify.app/docs/api/phone-numbers/phone-numbers" }, "response": [] }, { "name": "Update Phone Number Webhook", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/phone-numbers/update?phone_number_id=1&webhook_url=<>", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "phone-numbers", "update" ], "query": [ { "key": "phone_number_id", "value": "1", "description": "The phone number's unique ID (will be provided in the phone-numbers API response)" }, { "key": "webhook_url", "value": "<>", "description": "The endpoint used to receive incoming messages for a specific phone number." } ] }, "description": "This endpoint is used to update the incoming webhook URL for a phone number.\n\nDocumentation: https://easify.app/docs/api/phone-numbers/phone-numbers-update" }, "response": [] }, { "name": "Regenerate Webhook Secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/phone-numbers/regenerate-webhook-secret?phone_number_id=228", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "phone-numbers", "regenerate-webhook-secret" ], "query": [ { "key": "phone_number_id", "value": "228", "description": "The phone number's unique ID (will be provided in the phone-numbers API response)" } ] }, "description": "This endpoint is used to replace the webhook secret for a phone number.\n\nDocumentation: https://easify.app/docs/api/phone-numbers/phone-numbers-regenerate-webhook-secret" }, "response": [] }, { "name": "Remove Phone Number Webhook", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/phone-numbers/remove-webhook?phone_number_id=228", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "phone-numbers", "remove-webhook" ], "query": [ { "key": "phone_number_id", "value": "228", "description": "The phone number's unique ID (will be provided in the phone-numbers API response)" } ] }, "description": "This endpoint is used to remove the webhook from a phone number.\n\nDocumentation: https://easify.app/docs/api/phone-numbers/phone-numbers-remove-webhook" }, "response": [] } ] }, { "name": "Contacts", "item": [ { "name": "List Contacts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/contacts?limit=1&order=asc&page=2", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "contacts" ], "query": [ { "key": "limit", "value": "1", "description": "Pagination for contacts list (Default :10, Max :50)" }, { "key": "order", "value": "asc", "description": "Specifies the order in which the data should be sorted. Use asc for ascending order and desc for descending order; the default is desc" }, { "key": "page", "value": "2", "description": "The page number for paginated data" }, { "key": "group_id", "value": "", "description": "If the user sends a specific group_id, filter out the contacts of that group", "disabled": true } ] }, "description": "This endpoint is used to retrieve user's contacts.\n\nDocumentation: https://easify.app/docs/api/contact/contacts" }, "response": [] }, { "name": "Create Contact", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/contacts/create", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "contacts", "create" ] }, "body": { "mode": "raw", "raw": "{\n \"group_id\": 1,\n \"first_name\": \"Contact\",\n \"last_name\": \"Easify\",\n \"phone_number\": \"773638****\",\n \"country_code\": \"+1\",\n \"email_address\": \"easify@easify.app\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint is used to create a new contact.\n\nDocumentation: https://easify.app/docs/api/contact/contacts-create" }, "response": [] }, { "name": "Update Contact", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/contacts/update?contact_id=1&first_name=Contact&last_name=Easify&email_address=easify@easify.app&country_code=%2B1&phone_number=773638****", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "contacts", "update" ], "query": [ { "key": "contact_id", "value": "1", "description": "The specific contact ID for update (The contactID will be obtained from the contacts API response)" }, { "key": "first_name", "value": "Contact", "description": "First name for the contact (Maximum 20 characters are allowed)" }, { "key": "last_name", "value": "Easify", "description": "Last name for the contact (Maximum 20 characters are allowed)" }, { "key": "email_address", "value": "easify@easify.app", "description": "Email Address for the contact" }, { "key": "country_code", "value": "%2B1", "description": "Specific country code for the phone number (e.g.,+1 for US/Canada and +972 for Israel)." }, { "key": "phone_number", "value": "773638****", "description": "Phone number for the contact (US/Canada numbers must be 10 digits, and Israel numbers must be 9 digits)." }, { "key": "company", "value": "", "description": "Company name for the contact", "disabled": true }, { "key": "additional_1", "value": "", "description": "Additional fields for the contact", "disabled": true }, { "key": "additional_2", "value": "", "description": "Additional fields for the contact", "disabled": true }, { "key": "additional_3", "value": "", "description": "Additional fields for the contact", "disabled": true } ] }, "description": "This endpoint is used to update a contact.\n\nDocumentation: https://easify.app/docs/api/contact/contacts-update" }, "response": [] }, { "name": "Delete Contact", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/contacts/delete?contact_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "contacts", "delete" ], "query": [ { "key": "contact_id", "value": "1", "description": "The specific contact ID to delete (The contact IDwill be obtained from the contacts API response)" } ] }, "description": "This endpoint is used to delete a contact.\n\nDocumentation: https://easify.app/docs/api/contact/contacts-delete" }, "response": [] } ] }, { "name": "Contact Groups", "item": [ { "name": "List Contact Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/contact-groups?limit=1&order=asc&page=2", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "contact-groups" ], "query": [ { "key": "limit", "value": "1", "description": "Pagination for contact groups list (Default :10, Max :50)" }, { "key": "order", "value": "asc", "description": "Specifies the order in which the data should be sorted. Use asc for ascending order and desc fordescending order; the default is desc" }, { "key": "page", "value": "2", "description": "The page number for paginated data" } ] }, "description": "This endpoint is used to retrieve user's contact groups.\n\nDocumentation: https://easify.app/docs/api/contact-groups/contact-groups" }, "response": [] }, { "name": "Create Contact Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/contact-groups/create", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "contact-groups", "create" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Contact Group\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint is used to create a new contact group.\n\nDocumentation: https://easify.app/docs/api/contact-groups/contact-group-create" }, "response": [] }, { "name": "Update Contact Group", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/contact-groups/update?name=Updated Contact Group Name&group_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "contact-groups", "update" ], "query": [ { "key": "name", "value": "Updated Contact Group Name", "description": "Specify the name for the contact group" }, { "key": "group_id", "value": "1", "description": "The specific contact group ID for update (The group ID will be obtained from the contact-groups API response)" } ] }, "description": "This endpoint is used to update a contact group.\n\nDocumentation: https://easify.app/docs/api/contact-groups/contact-group-update" }, "response": [] }, { "name": "Delete Contact Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/contact-groups/delete?group_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "contact-groups", "delete" ], "query": [ { "key": "group_id", "value": "1", "description": "The specific contact group ID for update (Thegroup ID will be obtained from the contact-groups API response)" } ] }, "description": "This endpoint is used to delete a contact group.\n\nDocumentation: https://easify.app/docs/api/contact-groups/contact-group-delete" }, "response": [] } ] }, { "name": "Blacklist Contacts", "item": [ { "name": "Import Blacklist Contacts", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/blacklist-contacts/import", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "blacklist-contacts", "import" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "CSV File containing numbers to be blacklisted (Max Size: 2MB) Download Sample File" } ] }, "description": "The endpoint allows users to add numbers to the blacklist.\n\nDocumentation: https://easify.app/docs/api/blacklist-contacts/blacklist-contacts-import" }, "response": [] }, { "name": "Blacklist Import History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/blacklist-contacts/import/list?limit=10&page=2", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "blacklist-contacts", "import", "list" ], "query": [ { "key": "limit", "value": "10", "description": "Pagination for the list Default: 10 Minimum: 1, Maximum: 50" }, { "key": "page", "value": "2", "description": "The page number for paginated data Default: 1" } ] }, "description": "This endpoint is used to retrieve blacklist import history.\n\nDocumentation: https://easify.app/docs/api/blacklist-contacts/blacklist-contacts-import-list" }, "response": [] }, { "name": "Blacklist Import Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/blacklist-contacts/import/details?blacklist_contact_import_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "blacklist-contacts", "import", "details" ], "query": [ { "key": "blacklist_contact_import_id", "value": "1", "description": "ID of the import history to be retrieved Can be found in the response of blacklist-contacts/import and blacklist-contacts/import/list APIs." } ] }, "description": "The endpoint is used to retrieve the details of a single blacklist import history based on ID.\n\nDocumentation: https://easify.app/docs/api/blacklist-contacts/blacklist-contacts-import-details" }, "response": [] } ] }, { "name": "DNC Scrub", "item": [ { "name": "DNC Scrub", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/dnc/scrub", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "dnc", "scrub" ] }, "body": { "mode": "raw", "raw": "{\n \"phone\": \"+1773638****\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint scrubs US phone numbers against the Do Not Call (DNC) registry and returns the DNC status of each number.\n\nDocumentation: https://easify.app/docs/api/dnc-scrub/dnc-scrub" }, "response": [] } ] }, { "name": "Voice Call", "item": [ { "name": "Voice Call History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/voice-call/history?from=%2B1234567****&to[]=%2B1987654****&from_date=2024-12-01&to_date=2024-12-15&public_call=1&limit=10&order=desc&page=1&include_subusers=1", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "voice-call", "history" ], "query": [ { "key": "from", "value": "%2B1234567****", "description": "The original phone number of the call" }, { "key": "to[]", "value": "%2B1987654****", "description": "The destination phone number(s) of the call(maximum array size: 100)" }, { "key": "from_date", "value": "2024-12-01", "description": "The start date to filter calls (in YYYY-MM-DDformat)." }, { "key": "to_date", "value": "2024-12-15", "description": "The end date to filter calls (in YYYY-MM-DDformat)." }, { "key": "public_call", "value": "1", "description": "The public_call filter only returns public call history data" }, { "key": "limit", "value": "10", "description": "The number of records per page for pagination (Default: 10, Max: 50)." }, { "key": "order", "value": "desc", "description": "The sorting order of the records. Use asc for ascending or desc for descending order. Defaults to desc if not provided." }, { "key": "page", "value": "1", "description": "The page number to retrieve. Defaults to 1 if not provided." }, { "key": "include_subusers", "value": "1", "description": "If the authenticated user is an owner, they can fetch subuser's data by using the filter key include_subusers. Set include_subusers to true to fetch subuser's data." } ] }, "description": "Documentation: https://easify.app/docs/api/voice-call/voice-call-history" }, "response": [] } ] }, { "name": "Sub Users", "item": [ { "name": "Sub User Tokens", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/sub-user/tokens?email=easify@app.com", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "sub-user", "tokens" ], "query": [ { "key": "email", "value": "easify@app.com", "description": "Specific Email id of subuser" }, { "key": "limit", "value": "", "description": "Limit for pagination (Default: 10, Max: 50)", "disabled": true } ] }, "description": "This endpoint is used to fetch the Easify API tokens of sub users from the main user\n\nDocumentation: https://easify.app/docs/api/sub-user/sub-user-token" }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://backend.easify.app", "type": "string" }, { "key": "api_token", "value": "<>", "type": "string" } ] }