{"info":{"_postman_id":"dec4cadb-bff2-4336-a760-eb25bf4b74cc","name":"myCRMSIM API Documentation","description":"

myCRMSIM API Documentation

StartFragmentThe myCRMSIM API enables third-party applications (such as Make.com custom apps) to integrate with the myCRMSIM messaging platform. The API supports OAuth 2.0 authentication, inbound message webhooks, and outbound message dispatch across SMS, MMS, WhatsApp, iMessage, and RCS channels.EndFragment

Base URLs

Main API: https://backend.mysmsgateway.app
\n
SMS Dispatch: https://api.mysmsgateway.app
\n

Authentication

The API uses OAuth 2.0 Authorization Code Grant flow. All API endpoints require a Bearer access token in the Authorization header.

Rate Limits

Standard rate limits apply per OAuth client. Contact support for higher limits.

Support

For integration questions or technical issues, contact: support@mycrmsim.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"myCRMSIM API Documentation","slug":"mycrmsim-api-documentation"}],"owner":"50634098","collectionId":"dec4cadb-bff2-4336-a760-eb25bf4b74cc","publishedId":"2sBXwjvZ7m","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-21T15:48:22.000Z"},"item":[{"name":"OAuth - Authorize User","id":"d195fc88-00f8-45c7-8dfa-3874a37dd23f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

OAuth — Authorize User

Initiates the OAuth 2.0 authorization flow. This URL should be opened in the user's browser (not called from an API client) so they can sign in and grant consent.

Flow

Redirect user's browser to this URL with client_id, redirect_uri, response_type=code, and optional state.
\n
User signs in to myCRMSIM (if not already signed in).
\n
User clicks \"Allow\" on the consent page.
\n
myCRMSIM redirects the browser to redirect_uri with ?code=AUTH_CODE&state=....
\n
The application then exchanges the code for an access token using the /oauth/token endpoint.
\n

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Description
`client_id`	Yes	Your OAuth client ID
`redirect_uri`	Yes	Must match the registered redirect URI for your client
`response_type`	Yes	Must be `code`
`state`	Recommended	Random string for CSRF protection (echoed back in redirect)

Success Response

Redirects the browser to: {redirect_uri}?code=AUTHORIZATION_CODE&state=YOUR_STATE

Error Response

Redirects to: {redirect_uri}?error=ERROR_CODE&error_description=...

Note

This endpoint returns an HTML page for browser users. It cannot be called as a JSON API — it must be opened in a browser to trigger the OAuth consent flow.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"d195fc88-00f8-45c7-8dfa-3874a37dd23f"},{"name":"2. OAuth - Exchange Code for Token","id":"f231d9cb-6535-4327-b502-e22b8c0c668c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"

OAuth — Exchange Code for Token

Exchanges the authorization code (received via redirect after /oauth/authorize) for an access token + refresh token.

Request Headers

Authorization: Basic — HTTP Basic auth with your OAuth credentials
\n
Content-Type: application/json
\n

Request Body

{\n    \"grant_type\": \"authorization_code\",\n    \"code\": \"AUTH_CODE\",\n    \"redirect_uri\": \"https://www.make.com/oauth/cb/app\"\n}\n\n

Success Response (200)

{\n    \"access_token\": \"eyJhbGciOi...\",\n    \"refresh_token\": \"def502004a8b...\",\n    \"token_type\": \"Bearer\",\n    \"expires_in\": 3600\n}\n\n

Error Response

{\n    \"error\": \"invalid_grant\",\n    \"error_description\": \"The authorization code is invalid or expired.\"\n}\n\n

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"f231d9cb-6535-4327-b502-e22b8c0c668c"},{"name":"3. OAuth - Refresh Token","id":"a3e61e1f-73fd-432b-8221-6c88e6973b58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"

OAuth — Refresh Access Token

Uses a refresh token to obtain a new access token when the old one expires.

Request Headers

Authorization: Basic
\n
Content-Type: application/json
\n

Request Body

{\n    \"grant_type\": \"refresh_token\",\n    \"refresh_token\": \"EXISTING_REFRESH_TOKEN\"\n}\n\n

Success Response (200)

{\n    \"access_token\": \"eyJhbGciOi... (new)\",\n    \"refresh_token\": \"def502004a8b... (may rotate)\",\n    \"token_type\": \"Bearer\",\n    \"expires_in\": 3600\n}\n\n

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"a3e61e1f-73fd-432b-8221-6c88e6973b58"},{"name":"4. OAuth - Revoke Token","id":"fb2ee549-f76a-43c5-afb0-8f45c140be71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"

OAuth — Revoke Token

Invalidates an access token, preventing further use.

Request Headers

Authorization: Bearer ACCESS_TOKEN
\n
Content-Type: application/json
\n

Request Body

{\n    \"token\": \"ACCESS_TOKEN_TO_REVOKE\"\n}\n\n

Success Response (200)

Empty response body, HTTP 200 OK.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"fb2ee549-f76a-43c5-afb0-8f45c140be71"},{"name":"Get User Locations","id":"805aeee5-e987-49a2-b3aa-87270a6bfcad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Get User Info & Locations

Returns information about the authenticated user and their accessible locations. Used by Make.com to verify the OAuth connection and populate location dropdowns.

Request Headers

Authorization: Bearer ACCESS_TOKEN

Success Response (200)

{\n    \"data\": {\n        \"user\": {\n            \"id\": \"user_abc123\",\n            \"email\": \"user@example.com\",\n            \"name\": \"Jane Doe\"\n        }\n    }\n}\n\n

Note: The same endpoint also returns a list of locations the user has access to, used to populate location selection dropdowns in integrations.

Error Response (401)

{\n    \"error\": \"unauthorized\",\n    \"message\": \"Invalid or expired access token\"\n}\n\n

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"805aeee5-e987-49a2-b3aa-87270a6bfcad"},{"name":"Subscribe Webhook","id":"59479a43-37a0-43c3-b906-6fc7e6fa7986","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"\n

Registers a webhook URL to receive notifications when a new inbound SMS message arrives for the specified location.

Request Headers

Authorization: Bearer ACCESS_TOKEN
\n
Content-Type: application/json
\n

Request Body

{\n    \"targetUrl\": \"https://hook.eu1.make.com/your-webhook-url\",\n    \"event\": \"new_message\",\n    \"locationId\": \"loc_abc123\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`targetUrl`	The webhook URL that will receive POST notifications
`event`	Event type to subscribe to (currently `new_message`)
`locationId`	The location to monitor for inbound messages

Success Response (200)

{\n    \"webhook_id\": \"wh_xyz789\"\n}\n\n

Store webhook_id — needed to unsubscribe later.

Webhook Payload (sent to targetUrl)

When a new inbound SMS arrives, myCRMSIM POSTs this payload to targetUrl:

{\n    \"id\": \"msg_abc123\",\n    \"phone_number\": \"+923001234567\",\n    \"locationId\": \"loc_abc123\",\n    \"message\": \"Reply message text\",\n    \"created_at\": \"2026-05-21T10:00:00.000Z\"\n}\n\n

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"59479a43-37a0-43c3-b906-6fc7e6fa7986"},{"name":"Unsubscribe Webhook","id":"655e3171-60d8-440c-ab74-d72452e23c8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"

Unsubscribe Webhook

Removes a previously registered webhook subscription, stopping inbound message notifications.

Request Body

{\n    \"targetUrl\": \"https://hook.eu1.make.com/your-webhook-url\",\n    \"webhookId\": \"wh_xyz789\",\n    \"locationId\": \"loc_abc123\"\n}\n\n

Success Response (200)

{\n    \"success\": true\n}\n\n

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"655e3171-60d8-440c-ab74-d72452e23c8b"},{"name":"Send a Message","id":"ddde9795-986f-4dd6-a9c6-38ea34151303","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"

Send SMS / MMS

Sends an outbound SMS or MMS message to a specified phone number. Supports text, images, PDFs, and other attachments.

Endpoint

POST https://api.mysmsgateway.app/webhook
This is the generic send endpoint (used by the \"Send a message\" Make module). It defaults to the SMS channel. For channel-specific sending, use the dedicated endpoints below.EndFragment

Request Headers

Authorization: Bearer ACCESS_TOKEN
\n
Content-Type: application/json
\n

Request Body

{\n    \"phone\": \"+923001234567\",\n    \"locationId\": \"loc_abc123\",\n    \"message\": \"Hello from myCRMSIM\",\n    \"attachments\": [\n        \"https://example.com/file.jpg\"\n    ]\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Description
`phone`	Yes	Recipient phone number in E.164 format (e.g., `+923001234567`)
`locationId`	Yes	The location/sender identity to send from
`message`	Conditional	Message text. Required unless attachments are provided. Max 1600 chars.
`attachments`	No	Array of publicly accessible URLs to media files (images, PDFs, videos)

Success Response (200)

{\n    \"id\": \"msg_xyz789\",\n    \"phone\": \"+923001234567\",\n    \"locationId\": \"loc_abc123\",\n    \"message\": \"Hello from myCRMSIM\",\n    \"status\": \"sent\",\n    \"sent_at\": \"2026-05-21T10:00:00.000Z\"\n}\n\n

Error Responses

{\n    \"error\": \"invalid_phone\",\n    \"message\": \"Phone number must be in E.164 format\"\n}\n\n

{\n    \"error\": \"location_not_found\",\n    \"message\": \"The specified location does not exist or you don't have access to it\"\n}\n\n

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"ddde9795-986f-4dd6-a9c6-38ea34151303"},{"name":"Send SMS","id":"a9eeb59c-d0ef-4f51-a2a2-9bfb735826f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"phone\": \"+923001234567\", \r\n \"locationId\": \"loc_abc123\", \r\n \"message\": \"Hello from myCRMSIM via iMessage\",\r\n \"type\": \"sms\",\r\n \"attachments\": []\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.mysmsgateway.app/sms","description":"

StartFragment

Send SMS

Sends an outbound SMS text message. Used by the \"Send an SMS\" Make module.

Endpoint: POST https://api.mysmsgateway.app/sms

Request Headers

Authorization: Bearer ACCESS_TOKENContent-Type: application/json\n\n

Request Body

{    \"phone\": \"+923001234567\",    \"locationId\": \"loc_abc123\",    \"message\": \"Hello from myCRMSIM\",    \"type\": \"sms\",    \"attachments\": [\"https://example.com/file.jpg\"]}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Description
phone	Yes	Recipient phone number in E.164 format
locationId	Yes	The location/sender identity to send from
message	Conditional	Message text. Required unless attachments are provided. Max 1600 chars.
type	Yes	Channel selector. Must be `sms` for this endpoint.
attachments	No	Array of publicly accessible media URLs (sent as MMS where supported)

Success Response (200)

{    \"success\": true,    \"message\": \"Processed sms message and invoked outside-to-laravel-receive\",    \"outputFields\": {        \"status\": \"sent\",        \"channel\": \"sms\"    }}\n\n

A 200 response means the message was accepted and queued for delivery. Delivery status is visible in the myCRMSIM dashboard Message Logs.

EndFragment

\n","urlObject":{"protocol":"https","path":["sms"],"host":["api","mysmsgateway","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9eeb59c-d0ef-4f51-a2a2-9bfb735826f2"},{"name":"Send WhatsApp Message","id":"5b5456bf-b15d-4d4a-9f9a-2c431264e1c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"phone\": \"+923001234567\", \r\n \"locationId\": \"loc_abc123\", \r\n \"message\": \"Hello from myCRMSIM via iMessage\",\r\n \"type\": \"whatsapp\",\r\n \"attachments\": []\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.mysmsgateway.app/whatsapp","description":"

StartFragment

Send WhatsApp Message

Sends an outbound WhatsApp message. Used by the \"Send a WhatsApp message\" Make module.

Endpoint: POST https://api.mysmsgateway.app/whatsapp

Headers, body, and fields are identical to Send SMS, except type must be whatsapp.

Request Body

{    \"phone\": \"+923001234567\",    \"locationId\": \"loc_abc123\",    \"message\": \"Hello from myCRMSIM via WhatsApp\",    \"type\": \"whatsapp\",    \"attachments\": [\"https://example.com/file.jpg\"]}\n\n

Success Response (200)

{    \"success\": true,    \"message\": \"Processed whatsapp message and invoked ghl-to-whatsapp-receive\",    \"outputFields\": {        \"status\": \"sent\",        \"channel\": \"whatsapp\"    }}\n\n

EndFragment

\n","urlObject":{"protocol":"https","path":["whatsapp"],"host":["api","mysmsgateway","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b5456bf-b15d-4d4a-9f9a-2c431264e1c9"},{"name":"Send RCS Message","id":"127dc26a-ee7e-4e06-9ebb-88275a0200c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"phone\": \"+923001234567\", \r\n \"locationId\": \"loc_abc123\", \r\n \"message\": \"Hello from myCRMSIM via iMessage\",\r\n \"type\": \"rcs\",\r\n \"attachments\": []\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.mysmsgateway.app/rcs","description":"

StartFragment

Send RCS Message

Sends an outbound RCS message. Used by the \"Send an RCS message\" Make module.

Fallback: If the recipient's device does not support RCS, the message is delivered as SMS automatically by the gateway.

Endpoint: POST https://api.mysmsgateway.app/rcs

Headers, body, and fields are identical to Send SMS, except type must be rcs.

Request Body

{    \"phone\": \"+923001234567\",    \"locationId\": \"loc_abc123\",    \"message\": \"Hello from myCRMSIM via RCS\",    \"type\": \"rcs\",    \"attachments\": []}\n\n

Success Response (200)

{    \"success\": true,    \"message\": \"Processed rcs message and invoked ghl-to-rcs-receive\",    \"outputFields\": {        \"status\": \"sent\",        \"channel\": \"rcs\"    }}\n\n

{ \"error\": \"invalid_phone\", \"message\": \"Phone number must be in E.164 format\" }\n\n

{ \"error\": \"unauthorized\", \"message\": \"Invalid or expired access token\"\n\n

\n","urlObject":{"protocol":"https","path":["rcs"],"host":["api","mysmsgateway","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"127dc26a-ee7e-4e06-9ebb-88275a0200c7"},{"name":"Send iMessage","id":"c64285a3-872d-4a67-b6c4-6df6bed38513","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"phone\": \"+923001234567\", \r\n \"locationId\": \"loc_abc123\", \r\n \"message\": \"Hello from myCRMSIM via iMessage\",\r\n \"type\": \"imessage\",\r\n \"attachments\": []\r\n }","options":{"raw":{"language":"json"}}},"url":"POST https://api.mysmsgateway.app/imessage","description":"

Send iMessage

Sends an outbound iMessage. Used by the \"Send an iMessage\" Make module.

Fallback: If iMessage is unavailable for the recipient, the message is delivered as SMS automatically by the gateway.

Endpoint: POST https://api.mysmsgateway.app/imessage

Headers, body, and fields are identical to Send SMS, except type must be imessage.

Request Body

{    \"phone\": \"+923001234567\",    \"locationId\": \"loc_abc123\",    \"message\": \"Hello from myCRMSIM via iMessage\",    \"type\": \"imessage\",    \"attachments\": []}\n\n

Success Response (200)

{    \"success\": true,    \"message\": \"Processed imessage message and invoked ghl-to-imessage-receive\",    \"outputFields\": {        \"status\": \"sent\",        \"channel\": \"imessage\"    }}\n\n

\n","urlObject":{"protocol":"POST https","path":["imessage"],"host":["api","mysmsgateway","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"c64285a3-872d-4a67-b6c4-6df6bed38513"}]}

myCRMSIM API Documentation

Base URLs

Authentication

Rate Limits

Support

OAuth — Authorize User

Flow

Query Parameters

Success Response

Error Response

Note

OAuth — Exchange Code for Token

Request Headers

Request Body

Success Response (200)

Error Response

OAuth — Refresh Access Token

Request Headers

Request Body

Success Response (200)

OAuth — Revoke Token

Request Headers

Request Body

Success Response (200)

Get User Info & Locations

Request Headers

Success Response (200)

Error Response (401)

Subscribe to Inbound Message Webhook

Request Headers

Request Body

Success Response (200)

Webhook Payload (sent to targetUrl)

Unsubscribe Webhook

Request Body

Success Response (200)

Send SMS / MMS

Endpoint

Request Headers

Request Body

Success Response (200)

Error Responses

Send SMS

Send WhatsApp Message

Send RCS Message

Send iMessage