🚀 API v2 Documentation

{ "user_id": 4065 }

{ "user_id": 1, "permission": "user" }

{ "permission": "senior" }

{ "email": "example", "password": "example" }

{ "client_id": "example", "refresh_token": "example" }

{ "email": "[email protected]" }

{ "name": "Test Message Template", "text": "Hello, I am testing the template text for creating templates." }

{ "name": "Update name" }

{ "text": "Test Text 222222!" }

{ "user_id": 3 }

{ "user_group_id": 2 }

{ "contact_list_id": 1 }

{ "name": "Test MMS", "type": "SINGLE_BLAST", "text_message": "Testing MMS", "send_after_import": false }

{ "media_url": null }

{ "contacts": [ { "number": "15550000000", "first_name": "Alan", "last_name": "Boody", "company": "Slackers LLC" }, { "number": "19178267586", "first_name": "Jack", "last_name": "Gabbay", "company": "Z LLC" }, { "number": "19173187199", "first_name": "David", "last_name": "Barnathan", "company": "S LLC" } ], "send_after_import": false }

{ "field": "number", "value": [ "17147170140" ] }

{ "test_messages": [ { "number": "15550000000", "variables": { "first_name": "Alan", "last_name": "Boody" } } ] }

{ "schedule": "2025-08-21T08:00:00-05:00" }

{ "assigned_to": 555555 }

{ "user_id": 123 }

{ "flag_id": 43, "phoneNumbers": [ 15550000000 ] }

{ "action": "remove", "field": "newmeta" }

{ "name": "Elijah" }

{ "name": "My List Edited 2" }

{ "import_name": "Import Name", "contacts": [ { "number": "17326463866", "first_name": "iPhone", "last_name": "Seven", "company": "Slackers LLC" }, { "First": "Fred", "Last": "Doug", "company": "entrance", "message": "Hello , we are calling about your cars extended warranty", "number2": "12222222222" } ] }

{ "archive": true }

{ "action": "add", "meta": { "field": "new Meta", "value": "Meta value!" } }

{ "action": "edit", "meta": { "field": "newMeta", "value": "Meta value 22222!" } }

{ "number": "5173158330" }

{ "stop": "true" }

{ "name": "test", "color_id": "#000000" }

{ "name": "Test Update", "color_id": "#f1f1f1" }

{ "data": { "payload": { "autoresponse_type": null, "cc": [], "completed_at": null, "cost": null, "direction": "inbound", "encoding": "GSM-7", "errors": [], "from": { "carrier": "Verizon Wireless", "line_type": "Wireless", "phone_number": "+15550000000" }, "id": "89e392e0-39d3-4561-82b1-93b58007f717", "is_spam": false, "media": [], "messaging_profile_id": "40018695-6da6-477a-a06d-6934e009e717", "organization_id": "c69dc7e5-664a-421b-a604-c1f7a8424722", "parts": 1, "received_at": "2023-06-03T22:18:03.279+00:00", "record_type": "message", "sent_at": null, "subject": "", "tags": [], "text": "start2", "to": [ { "carrier": "Telnyx", "line_type": "Wireless", "phone_number": "+15864350601", "status": "webhook_delivered" } ], "type": "SMS", "valid_until": null, "webhook_failover_url": null, "webhook_url": "https://beta.entrancegrp.com/api/messages/receive_sms" } } }

{ "keyword": "test" }

{ "name": "My Influencer List", "influencer_opt_in_message": "Message that is texted back once contact opts into influencer list.", "influencer_subscribe_keywords": ["join", "subscribe", "start", "etc"] // List of opt in keywords that a contact texts to opt into the influencer list. }

{ "name": "My Influencer List", "influencer_opt_in_message": "Message that is texted back once contact opts into influencer list." }

{ "workspace_number": "15550000000", "workspace_number_id": 1111 }

{ "add": [ "join", "subscribe" ], "remove": [ "join", "subscribe" ] }

{ "phrase": "5550000000", "contains": false, "unsubscribe": true }

{ "phrase": "Test", "contains": true, "unsubscribe": true }

{ "phrase": "Change Phrase", "contains": true, "unsubscribe": false }

{ "name": "AasdfAasdf", "text": "Hello, I am testing the template text for creating templates." }

{ "text": "Update text" }

{ "channel_id": 1028, "message": "Create Unread" }

{ "state": "Michigan", "count": 1 }

{ "name": "My Messaging Profile" }

{ "data": { "payload": { "autoresponse_type": null, "cc": [], "completed_at": null, "cost": null, "direction": "inbound", "encoding": "GSM-7", "errors": [], "from": { "carrier": "Verizon Wireless", "line_type": "Wireless", "phone_number": "+15550000000" }, "id": "89e392e0-39d3-4561-82b1-93b58007f717", "is_spam": false, "media": [], "messaging_profile_id": "40018695-6da6-477a-a06d-6934e009e717", "organization_id": "c69dc7e5-664a-421b-a604-c1f7a8424722", "parts": 1, "received_at": "2023-06-08T22:18:03.279+00:00", "record_type": "message", "sent_at": null, "subject": "", "tags": [], "text": "start", "to": [ { "carrier": "Telnyx", "line_type": "Wireless", "phone_number": "+15864350601", "status": "webhook_delivered" } ], "type": "SMS", "valid_until": null, "webhook_failover_url": null, "webhook_url": "https://beta.entrancegrp.com/api/messages/receive_sms" } } }

{ "testWebhookData": "test" }

{ "message": "Testing apiv2 message sending" }

{ "message": "test message" }

{ "redirect": "https://beta.entrancegrp.com/api" }

{ "contact_id": 1 }

{ "name": "MyClass", "isInfluencerList": true // Set to true only if you want the list to be an influencer list. It'll set it to private automatically as well }

{ "name": "Update Name", "private": true, "archive": true }

{ "user_id": 1 }

{ "name": "test" }

{ "name": "test" }

{ "email": "[email protected]", "firstname": "Alan", "lastname": "Boody", "phoneNumber": "15550000000" }

{ "exclude_from_campaigns": true }

{ "oldPassword": "asdfasdf2", "password": "asdfasdf" }

{ "token": "ExponentPushToken[7GYQ-FDfiMPE9AaI6HPSf9]" }

{ "name": "Mier Inbound Messages", "url": "https://sequence.linktex.ai/api/sms-response", "subscriptions": [ "newMessage" ] }

{ "subscriptions": [ "messageStatus", "newMessage" ] }

{ "subscriptions": [ "shortlinkClick" ] }

{ "number": "5550000000" }

{ "organization_name": "My Organization Name", "country_code": "US", "webhook": { "name": "Webhook Name", "url": "https://beta.entrancegrp.com/api/messages/receive_sms2", "subscriptions": [ "campaignCreated", "campaignSent", "messageStatus", "newMessage", "shortlinkClick", "campaignSending" ] } }

{ "organization_name": "My Name 2" }

{ "channel_locking": true }