{"info":{"_postman_id":"a347309d-7fd2-4a4f-aa99-0b24cf31244f","name":"MessageSpring","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"30785900","collectionId":"a347309d-7fd2-4a4f-aa99-0b24cf31244f","publishedId":"2sAXxLDFHk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0073B1"},"publishDate":"2024-10-04T08:30:48.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"2aa5f077-083b-41da-8ba7-25a8f30266df","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"554e0dde-f305-47ef-95c5-0f31e85518a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"{{place_username}}\",\n\t\"password\": \"{{place_password}}\",\n\t\"clientId\": \"{{client_id}}\",\n\t\"clientSecret\": \"{{client_secret}}\"\n}"},"url":"https://user-api.messagespring.com/v1/login","description":"

This endpoint allows the user to authenticate by providing their credentials and receive an access token for future API calls.

Request Body

The request body must include the user's email, password, and client authentication details (clientId and clientSecret).

Fields

email (string, required): The user's email address.
\n
password (string, required): The user's password.
\n
clientId (string, required): The client ID for the application requesting authentication.
\n
clientSecret (string, required): The client secret for the application requesting authentication.
\n

Response

The response includes an access token that can be used to authenticate future requests, as well as information on token expiration and refresh tokens.

Fields

accessToken (string): The token to be used for subsequent API requests.
\n
expiresIn (integer): The time in seconds until the access token expires.
\n
refreshToken (string): A token that can be used to obtain a new access token when the current one expires.
\n
tokenType (string): The type of token, typically \"Bearer\".
\n

\n","urlObject":{"protocol":"https","path":["v1","login"],"host":["user-api","messagespring","com"],"query":[],"variable":[]}},"response":[{"id":"850f0385-01ac-4c14-bdf1-ba6a1550a4f7","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"{{place_username}}\",\n\t\"password\": \"{{place_password}}\",\n\t\"clientId\": \"{{client_id}}\",\n\t\"clientSecret\": \"{{client_secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://user-api.messagespring.com/v1/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyNax\",\n \"expiresIn\": 3600,\n \"refreshToken\": \"eyNaz\",\n \"tokenType\": \"Bearer\"\n}"},{"id":"58238d90-0e9a-4202-85f4-160bf8166068","name":"Login","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"email\":\"lemogo3067@digdy.com\",\"password\":\"eT44hTxRcnUPgy6\",\"clientId\":\"2\",\"clientSecret\":\"TLjk5l9uZpvahwFOPArWgyiZ5vUKZP0JiIqk0HWP\",\"rememberMe\":false}"},"url":"http://localhost/v1/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"422"},{"key":"ETag","value":"W/\"1a6-2GCGc1KA1C1cqBd8arn4568kj0I\""},{"key":"Date","value":"Wed, 11 Jun 2025 04:30:17 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjIzMzQsImlhdCI6MTc0OTYxNjIxNCwiZXhwIjoxNzQ5NjE5ODE0LCJzdWIiOiJBY2Nlc3NUb2tlbiJ9.AxySG2wo33ImFUv2T3suYZdxJnUl8Quv7mIpCukPr6g\",\n \"expiresIn\": 3600,\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjIzMzQsImlhdCI6MTc0OTYxNjIxNCwiZXhwIjoxNzUyMzE2MjE0LCJzdWIiOiJSZWZyZXNoVG9rZW4ifQ.1L2TbosV-HuysD4RTw9K3MXRPfZhWMp8XBBG7ytCc64\",\n \"tokenType\": \"Bearer\"\n}"}],"_postman_id":"554e0dde-f305-47ef-95c5-0f31e85518a1"},{"name":"My Profile","event":[{"listen":"test","script":{"id":"2aa5f077-083b-41da-8ba7-25a8f30266df","exec":[""],"type":"text/javascript","packages":{}}}],"id":"7320c6cb-2fc3-4886-a96b-31f2d776dfeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://user-api.messagespring.com/v1/users/my","description":"

This endpoint allows you to retrieve information about the authenticated user, including their profile details, associated places, and roles. The placeId can be extracted from this response and used in other API endpoints that require it.

Response

The response includes information about the authenticated user, such as their name, email, phone number, and the places they are associated with.

Fields

id (integer): The unique identifier of the user.
\n
firstName (string): The user's first name.
\n
lastName (string): The user's last name.
\n
email (string): The user's email address.
\n
newEmail (string): The user's new email, if it's in the process of being updated.
\n
countryCode (string): The country code of the user's phone number.
\n
phoneNumber (string): The user's phone number.
\n
avatar (string, URL): The URL of the user's avatar image.
\n
timezone (string, nullable): The user's timezone.
\n
localizationLanguage (object): The language settings of the user.
\n
- id (integer): The ID of the language.
  \n
- code (string): The language code (e.g., \"en\").
  \n
- name (string): The name of the language.
  \n
- nativeName (string): The native name of the language.
  \n
\n
createdAt (string, timestamp): The timestamp of when the user was created.
\n
updatedAt (string, timestamp): The timestamp of when the user was last updated.
\n
suspended (integer): A flag indicating whether the user's account is suspended (0 for no, 1 for yes).
\n
places (array): A list of places associated with the user.
\n
- id (integer): The unique identifier of the place.
  \n
- name (string): The name of the place.
  \n
- email (string): The place's email address.
  \n
- info (object): Additional information about the place.
  \n
  - address (string): The address of the place.
    \n
  - latitude (float): The latitude coordinate of the place.
    \n
  - longitude (float): The longitude coordinate of the place.
    \n
  - timezone (string): The place's timezone.
    \n
  - phoneNumber (string): The place's phone number.
    \n
  - logo (string, URL): The URL of the place's logo.
    \n
  \n
\n
isOwner (boolean): A flag indicating if the user is the owner of the account.
\n
defaultLanguage (array): A list of default language settings for the user.
\n
- id (integer): The ID of the default language.
  \n
- code (string): The code of the default language (e.g., \"en\").
  \n
- name (string): The name of the default language.
  \n
\n
avatarCharacters (string): The characters displayed in the user's avatar.
\n

\n","urlObject":{"protocol":"https","path":["v1","users","my"],"host":["user-api","messagespring","com"],"query":[],"variable":[]}},"response":[{"id":"7b5ad082-251f-491d-b98d-c51f29f43ccd","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://user-api.messagespring.com/v1/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1983,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"newEmail\": \"john.doe@newexample.com\",\n \"countryCode\": \"+1\",\n \"phoneNumber\": \"1234567890\",\n \"avatar\": \"https://ik.imagekit.io/notifyme/dev/user-avatars/john_doe_avatar.jpeg\",\n \"timezone\": \"America/New_York\",\n \"localizationLanguage\": {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"nativeName\": \"English\"\n },\n \"createdAt\": \"2023-01-24T03:42:58.000Z\",\n \"updatedAt\": \"2024-08-05T08:36:25.000Z\",\n \"suspended\": 0,\n \"places\": [\n {\n \"id\": 2305,\n \"name\": \"Acme Corporation\",\n \"email\": \"admin@acme.com\",\n \"newEmail\": null,\n \"paypalEmail\": null,\n \"cardBrand\": null,\n \"cardLastFour\": null,\n \"trialEndsAt\": \"2023-04-24T03:43:56.000Z\",\n \"creatorId\": 1983,\n \"mobileVisibilityStatus\": 1,\n \"createdAt\": \"2023-01-24T03:42:58.000Z\",\n \"updatedAt\": \"2024-07-16T08:26:31.000Z\",\n \"userPlace\": {\n \"suspendedReason\": null\n },\n \"info\": {\n \"authMethod\": \"hybrid\",\n \"about\": \"Acme Corporation is a leading supplier of innovative products and services.\",\n \"description\": \"Acme Corporation provides top-tier solutions to global clients across various industries.\",\n \"contactUrl\": \"https://acme.com/contact\",\n \"website\": \"https://acme.com\",\n \"isSuspended\": false,\n \"isBeaconEnabled\": true,\n \"address\": \"123 Main Street, Springfield, USA\",\n \"latitude\": 37.774929,\n \"longitude\": -122.419416,\n \"timezone\": \"America/Los_Angeles\",\n \"countryCode\": \"+1\",\n \"phoneNumber\": \"9876543210\",\n \"logo\": \"https://ik.imagekit.io/notifyme/dev/logos/acme_corp_logo.jpeg\",\n \"shouldSeeCarecheck\": false,\n \"shouldSeeCarecheckBtn\": false,\n \"isTranslationEnabled\": 0,\n \"suspendedReason\": null\n },\n \"interested\": {\n \"beacon\": false\n },\n \"roles\": [\n {\n \"id\": 1328,\n \"name\": \"Administrator\",\n \"type\": 2,\n \"createdAt\": \"2023-01-24T03:43:56.000Z\",\n \"updatedAt\": \"2023-01-24T03:43:56.000Z\",\n \"permissions\": [],\n \"groups\": []\n }\n ]\n }\n ],\n \"isOwner\": true,\n \"defaultLanguage\": [\n {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"sortOrder\": 0,\n \"status\": 0,\n \"nativeName\": \"English\"\n }\n ],\n \"avatarCharacters\": \"JD\"\n}\n"}],"_postman_id":"7320c6cb-2fc3-4886-a96b-31f2d776dfeb"}],"id":"9476fc68-a3a7-4c3d-b49c-9283e1eb44dc","_postman_id":"9476fc68-a3a7-4c3d-b49c-9283e1eb44dc","description":""},{"name":"Message","item":[{"name":"Compose Message","event":[{"listen":"test","script":{"id":"13a24281-57e7-4fb9-972e-ee7ad7880695","exec":[""],"type":"text/javascript","packages":{}}}],"id":"c26ed53f-9dad-4658-9a02-d9c5e1a244f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": 1,\n \"priority\": 1,\n \"translations\": [\n {\n \"title\": \"

Hello World!

\",\n \"fullBody\": \"

You're getting this message on your preferred channels

This API allows you to broadcast messages across multiple channels, such as email, SMS, push notifications, and social media platforms. You can target recipients by defining groups or selecting individual users. Additionally, events can be created with specific start and end times, along with location details.

The API also supports topics, enabling subscribers to filter incoming messages based on the topics they follow. This feature is particularly helpful for users who receive a high volume of messages, as it allows them to prioritize content that is relevant to their interests.

Request Body

type (Number, Required): Defines the type of message.
\n
- 1: General
  \n
- 2: Event
  \n
\n
priority (Number, Required): Specifies the message priority level.
\n
- 1: Informational
  \n
- 2: Important
  \n
- 3: Emergency
  \n
- 4: Urgent
  \n
\n
translations (Array, Required): A list of translations for the message.
\n
- title (String, Required): The message title.
  \n
- fullBody (String, Required): The message body.
  \n
\n
shortName (String): A short identifier for the place.
\n
startTime (String): The start time for an event. Required when type is 2 (Event).
\n
endTime (String): The end time for an event. Required when type is 2 (Event).
\n
timezone (String): The timezone for the event. Required when type is 2 (Event).
\n
address (String): The location address for an event. Required when type is 2 (Event).
\n
latitude (Decimal): The latitude of the event’s location. Required when type is 2 (Event).
\n
longitude (Decimal): The longitude of the event’s location. Required when type is 2 (Event).
\n
allowConversation (Boolean, Required): Indicates whether replies are allowed for this message.
\n
isTtsEnabled (Boolean, Required): Enables text-to-speech (TTS) for the message.
\n
entityType (Number, Required): Specifies whether the message is sent to groups or individual recipients.
\n
- 1: Everyone (Deprecated)
  \n
- 2: Groups
  \n
- 3: Individual subscribers
  \n
\n
entityIds (Array, Required): An array of subgroup IDs to target groups.
\n
subscriberIds (Array, Required): An array of subscriber IDs to target individual recipients.
\n
channels (Array, Required): The channels to send the message through.
\n
- 1: App Push Notification
  \n
- 2: SMS
  \n
- 3: Email
  \n
- 9: Automated Call
  \n
\n
topicIds (Array, Required): A list of topic IDs associated with the message.
\n
pageIds (Array): A list of Facebook Page IDs for posting.
\n
isSharingEnabled (Boolean, Required): Specifies whether the message is shareable via a generated web page.
\n
displayHistory (Boolean): Indicates if the generated web page should appear in the history. Only applicable when isSharingEnabled is true.
\n
twitter (Boolean): Indicates if the message will be posted on Twitter.
\n
linkedin (Boolean): Indicates if the message will be posted on LinkedIn.
\n
date (Date): The scheduled date to send the message (in ISO format).
\n
scheduleTimezone (String): The timezone for scheduling the message. (Timezone ID format).
\n
remindDate (Date): The date for sending a reminder message (in ISO format).
\n
reminderTimezone (String): The timezone for sending reminders. (Timezone ID format).
\n

Response Body

id (Number): The unique ID of the created message.

\n","urlObject":{"protocol":"https","path":["v1","places",":placeId","notifications"],"host":["user-api","messagespring","com"],"query":[],"variable":[{"description":{"content":"

(integer, required): The ID of the place

\n","type":"text/plain"},"type":"any","value":"{{place_id}}","key":"placeId"}]}},"response":[{"id":"f99d8744-0afc-44aa-bf09-feadf81e5acc","name":"201","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": 1,\n \"priority\": 1,\n \"translations\": [\n {\n \"title\": \"

Hello World!

\",\n \"fullBody\": \"

You're getting this message on your preferred channels

\"\n }\n ],\n \"shortName\": \"PGCafe\",\n \"startTime\": null,\n \"endTime\": null,\n \"timezone\": null,\n \"address\": null,\n \"latitude\": null,\n \"longitude\": null,\n \"allowConversation\": true,\n \"isTtsEnabled\": true,\n \"entityType\": 3,\n \"entityIds\": [],\n \"subscriberIds\": [\n 331778\n ],\n \"channels\": [\n 1\n ],\n \"topicIds\": [],\n \"pageIds\": [],\n \"isSharingEnabled\": true,\n \"displayHistory\": false,\n \"twitter\": false,\n \"linkedin\": false,\n \"date\": null,\n \"scheduleTimezone\": \"Asia/Tokyo\",\n \"remindDate\": null,\n \"reminderTimezone\": \"Asia/Tokyo\"\n}"},"url":{"raw":"https://user-api.messagespring.com/v1/places/:placeId/notifications","protocol":"https","host":["user-api","messagespring","com"],"path":["v1","places",":placeId","notifications"],"variable":[{"key":"placeId","value":"{{place_id}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 42914\n}"}],"_postman_id":"c26ed53f-9dad-4658-9a02-d9c5e1a244f1"}],"id":"ed6bdc96-856b-4f07-b599-05be4b91e2fe","_postman_id":"ed6bdc96-856b-4f07-b599-05be4b91e2fe","description":""},{"name":"Topic","item":[{"name":"Create Topic","event":[{"listen":"test","script":{"id":"1f5455e3-357d-402d-b782-b54fc22846b6","exec":[""],"type":"text/javascript","packages":{}}}],"id":"236a269a-b75d-4ff6-9be5-67095d54bb0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"Summer Sale! 🌞🏖️\",\n \"description\": \"Summer Sale! 🌞🏖️\",\n \"isActive\": 1\n}"},"url":"https://user-api.messagespring.com/v1/places/:placeId/topics","description":"

This API endpoint creates a new topic with the specified details.

Request Body

name (String, required): The name of the topic.
\n
description (String, required): A brief description of the topic.
\n
isActive (Number, required): The status of the topic. Use 1 for active and 0 for inactive.
\n

Response Body

id (Number): The unique identifier for the created topic.

\n","urlObject":{"protocol":"https","path":["v1","places",":placeId","topics"],"host":["user-api","messagespring","com"],"query":[],"variable":[{"description":{"content":"

(integer, required): The ID of the place

\n","type":"text/plain"},"type":"any","value":"{{place_id}}","key":"placeId"}]}},"response":[{"id":"047b4e37-baa9-4146-8499-f068ef774f8b","name":"201","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"Summer Sale! 🌞🏖️\",\n \"description\": \"Summer Sale! 🌞🏖️\",\n \"isActive\": 1\n}"},"url":{"raw":"https://user-api.messagespring.com/v1/places/:placeId/topics","protocol":"https","host":["user-api","messagespring","com"],"path":["v1","places",":placeId","topics"],"variable":[{"key":"placeId","value":"{{place_id}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1192\n}"}],"_postman_id":"236a269a-b75d-4ff6-9be5-67095d54bb0a"},{"name":"List Topics","event":[{"listen":"test","script":{"id":"a7440efc-76f4-431b-970b-64f96b81d74c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"8d408d80-b916-4df3-a3cf-55b3f45d7b1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://user-api.messagespring.com/v1/places/:placeId/topics?page=1&limit=10&status=1&sort=name:ASC¬ificationCount=1&keyword=Lead","description":"

This endpoint retrieves a list of topics associated with a specific place, identified by the :placeId parameter. The request supports query parameters for pagination, status filtering, sorting, and additional filters such as notification count and topic ID.

Response

The response contains a list of topics matching the given parameters, as well as pagination metadata.

data: An array containing the list of topics.
\n
- id (Number): The unique identifier for the topic.
  \n
- name (String): The name of the topic.
  \n
- description (String): A brief description of the topic.
  \n
- isActive (Number): Indicates if the topic is active (1) or inactive (0).
  \n
- subscriberIds (Array): An array of subscriber IDs linked to the topic.
  \n
- notificationsCount (Number): The number of notifications associated with the topic.
  \n
- subscribersCount (Number): The number of subscribers following the topic.
  \n
- inactiveFollower (Number): The count of inactive followers.
  \n
- createdAt (String): The date and time when the topic was created (ISO 8601 format).
  \n
- updatedAt (String): The date and time when the topic was last updated (ISO 8601 format).
  \n
\n
meta: Metadata for pagination.
\n
- currentPage (Number): The current page number.
  \n
- lastPage (Number): The total number of pages.
  \n
- perPage (Number): The number of topics per page.
  \n
- total (Number): The total number of topics retrieved.
  \n
\n

\n","urlObject":{"protocol":"https","path":["v1","places",":placeId","topics"],"host":["user-api","messagespring","com"],"query":[{"description":{"content":"

(Number): The page number for pagination.

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

(Number): The maximum number of topics to retrieve per page.

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

(Number): Filter topics by their status (e.g., active or inactive).

\n","type":"text/plain"},"key":"status","value":"1"},{"description":{"content":"

(String): Sort the topics by a specified field (e.g., name, date) and order (e.g., ascending or descending).

\n","type":"text/plain"},"key":"sort","value":"name:ASC"},{"description":{"content":"

(Number): Filter topics by their notification count.

\n","type":"text/plain"},"key":"notificationCount","value":"1"},{"description":{"content":"

(String): Filter topics by search keywords.

\n","type":"text/plain"},"key":"keyword","value":"Lead"}],"variable":[{"description":{"content":"

(integer, required): The ID of the place

\n","type":"text/plain"},"type":"any","value":"{{place_id}}","key":"placeId"}]}},"response":[{"id":"50f18292-627f-44f9-b58c-8a305f16571c","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://user-api.messagespring.com/v1/places/:placeId/topics?page=1&limit=10&status=1&sort=name:ASC¬ificationCount=1","protocol":"https","host":["user-api","messagespring","com"],"path":["v1","places",":placeId","topics"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"status","value":"1"},{"key":"sort","value":"name:ASC"},{"key":"notificationCount","value":"1"},{"key":"keyword","value":"Lead","disabled":true}],"variable":[{"key":"placeId","value":"{{place_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1688,\n \"name\": \"Hello\",\n \"description\": \"World\",\n \"isActive\": 1,\n \"subscriberIds\": [],\n \"notificationsCount\": 0,\n \"subscribersCount\": 0,\n \"inactiveFollower\": 0,\n \"createdAt\": \"2024-10-04T06:04:17.000Z\",\n \"updatedAt\": \"2024-10-04T06:04:17.000Z\"\n }\n ],\n \"meta\": {\n \"currentPage\": 1,\n \"lastPage\": 1,\n \"perPage\": 10,\n \"total\": 1\n }\n}"}],"_postman_id":"8d408d80-b916-4df3-a3cf-55b3f45d7b1d"},{"name":"Follow Subscribers to a Topic","event":[{"listen":"test","script":{"id":"77e17a73-01e7-45f4-b402-7b55725b634c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"8f10f458-8fbc-4ec1-91fc-1a86cdeffb1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subscriberIds\": [\n 327976\n ]\n}"},"url":"https://user-api.messagespring.com/v1/places/:placeId/topics/:topicId/follow","description":"

This endpoint allows you to follow one or more subscribers to a specific topic.

Request Body

The request body should be a JSON object containing a list of subscriber IDs to be followed to the topic.

Fields

subscriberIds (array of integers, required): A list of the subscriber IDs to be followed to the topic.

Response

A successful request returns an HTTP status code 200 OK without any content (empty body).

Response Example:

Status: 200 OK
\n
Body: (empty)
\n

\n","urlObject":{"protocol":"https","path":["v1","places",":placeId","topics",":topicId","follow"],"host":["user-api","messagespring","com"],"query":[],"variable":[{"description":{"content":"

(integer, required): The ID of the place where the topic is located.

\n","type":"text/plain"},"type":"any","value":"{{place_id}}","key":"placeId"},{"description":{"content":"

(integer, required): The ID of the topic to which you want to follow subscribers.

\n","type":"text/plain"},"type":"any","value":"{{place_topic_id}}","key":"topicId"}]}},"response":[{"id":"affc9b17-9d3b-40ea-8bd2-ec16b8104183","name":"200","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subscriberIds\": [\n 327976\n ]\n}"},"url":{"raw":"https://user-api.messagespring.com/v1/places/:placeId/topics/:topicId/follow","protocol":"https","host":["user-api","messagespring","com"],"path":["v1","places",":placeId","topics",":topicId","follow"],"variable":[{"key":"placeId","value":"{{place_id}}"},{"key":"topicId","value":"{{place_topic_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8f10f458-8fbc-4ec1-91fc-1a86cdeffb1e"}],"id":"d0643979-9a35-4653-af77-c44b0fedb473","_postman_id":"d0643979-9a35-4653-af77-c44b0fedb473","description":""},{"name":"Group","item":[{"name":"List Groups","event":[{"listen":"test","script":{"id":"285d175b-72ea-47f8-b01d-bed29def868a","exec":[""],"type":"text/javascript","packages":{}}}],"id":"529bb38d-f259-4252-bb4c-268c0ca591c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://user-api.messagespring.com/v1/places/:placeId/groups?page=1&limit=10","description":"

This endpoint retrieves a paginated list of groups associated with a specific place.

Response

The response contains a JSON object with a list of groups and metadata about pagination.

Fields

data (array): A list of groups associated with the place.
\n
- id (integer): The unique identifier for the group.
  \n
- name (string): The name of the group.
  \n
- type (integer): The type of the group (e.g., 0 for standard group, 1 for special, 2 for system-generated).
  \n
- placeId (integer): The ID of the place to which the group belongs.
  \n
- createdAt (string): The timestamp when the group was created (ISO 8601 format).
  \n
- updatedAt (string): The timestamp when the group was last updated (ISO 8601 format).
  \n
- subscribersCount (integer): The number of subscribers in the group.
  \n
- tagsCount (integer): The number of subgroups associated with the group.
  \n
- membershipCardsCount (integer): The number of membership cards associated with the group.
  \n
\n
meta (object): Metadata related to the pagination of the results.
\n
- currentPage (integer): The current page number.
  \n
- lastPage (integer): The last page number available.
  \n
- perPage (integer): The number of groups returned per page.
  \n
- total (integer): The total number of groups available.
  \n
\n

\n","urlObject":{"protocol":"https","path":["v1","places",":placeId","groups"],"host":["user-api","messagespring","com"],"query":[{"description":{"content":"

(integer, optional): The page number of the paginated results. Default is 1.

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

(integer, optional): The number of groups to return per page. Default is 10.

\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[{"description":{"content":"

(integer, required): The ID of the place for which groups are being fetched.

\n","type":"text/plain"},"type":"any","value":"{{place_id}}","key":"placeId"}]}},"response":[{"id":"0933d495-5d89-4a13-9331-2043785162ac","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://user-api.messagespring.com/v1/places/:placeId/groups?page=1&limit=10","protocol":"https","host":["user-api","messagespring","com"],"path":["v1","places",":placeId","groups"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[{"key":"placeId","value":"{{place_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 3376,\n \"name\": \"Everyone\",\n \"type\": 1,\n \"placeId\": 2305,\n \"createdAt\": \"2023-01-24T03:43:56.000Z\",\n \"updatedAt\": \"2023-01-24T03:43:56.000Z\",\n \"subscribersCount\": 148,\n \"tagsCount\": 1,\n \"membershipCardsCount\": 0\n },\n {\n \"id\": 3377,\n \"name\": \"Subscribers without a Group\",\n \"type\": 2,\n \"placeId\": 2305,\n \"createdAt\": \"2023-01-24T03:43:56.000Z\",\n \"updatedAt\": \"2023-01-24T03:43:56.000Z\",\n \"subscribersCount\": 145,\n \"tagsCount\": 1,\n \"membershipCardsCount\": 0\n },\n {\n \"id\": 3387,\n \"name\": \"English\",\n \"type\": 0,\n \"placeId\": 2305,\n \"createdAt\": \"2023-01-28T17:08:02.000Z\",\n \"updatedAt\": \"2023-01-28T17:08:02.000Z\",\n \"subscribersCount\": 3,\n \"tagsCount\": 1,\n \"membershipCardsCount\": 0\n },\n {\n \"id\": 5379,\n \"name\": \"Sale Team\",\n \"type\": 0,\n \"placeId\": 2305,\n \"createdAt\": \"2024-10-04T06:23:18.000Z\",\n \"updatedAt\": \"2024-10-04T06:23:18.000Z\",\n \"subscribersCount\": 0,\n \"tagsCount\": 3,\n \"membershipCardsCount\": 0\n }\n ],\n \"meta\": {\n \"currentPage\": 1,\n \"lastPage\": 1,\n \"perPage\": 10,\n \"total\": 4\n }\n}"}],"_postman_id":"529bb38d-f259-4252-bb4c-268c0ca591c0"},{"name":"Create Group","event":[{"listen":"test","script":{"id":"0585814c-16b8-4e35-938a-37e6a3e92b68","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f6f70278-a0db-41c6-9482-fb8dd85d2961","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sale Team\",\n \"tags\": [\n {\n \"name\": \"Social Media Division\"\n },\n {\n \"name\": \"Medical Equipment Division\"\n }\n ]\n}"},"url":"https://user-api.messagespring.com/v1/places/:placeId/group","description":"

This endpoint allows you to create a new group.

Request Body

name (string, required): The name of the group.
\n
tags (array of objects, required): An array of subgroup objects, each containing a name property representing a subgroup associated with the group. Example:
\n
```
      [\n          { \"name\": \"outdoor\" },\n          { \"name\": \"family-friendly\" }\n      ]\n\n
```
\n

Response

On success, the response will return a JSON object containing the ID of the newly created group

\n","urlObject":{"protocol":"https","path":["v1","places",":placeId","group"],"host":["user-api","messagespring","com"],"query":[],"variable":[{"type":"any","value":"{{place_id}}","key":"placeId"}]}},"response":[{"id":"6fff7365-010c-4afb-b3b4-6f9cbadbbf59","name":"201","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sale Team\",\n \"tags\": [\n {\n \"name\": \"Social Media Division\"\n },\n {\n \"name\": \"Medical Equipment Division\"\n }\n ]\n}"},"url":{"raw":"https://user-api.messagespring.com/v1/places/:placeId/group","protocol":"https","host":["user-api","messagespring","com"],"path":["v1","places",":placeId","group"],"variable":[{"key":"placeId","value":"{{place_id}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5379\n}"}],"_postman_id":"f6f70278-a0db-41c6-9482-fb8dd85d2961"},{"name":"Get Group Details","event":[{"listen":"test","script":{"id":"285d175b-72ea-47f8-b01d-bed29def868a","exec":[""],"type":"text/javascript","packages":{}}}],"id":"72b3a12c-68d5-4c92-92d3-91054ec0499d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://user-api.messagespring.com/v1/groups/:groupId","description":"

This endpoint retrieves detailed information about a specific group.

Response

The response contains a JSON object with detailed information about the group, including its associated subgroups and users.

Fields

id (integer): The unique identifier for the group.
\n
placeId (integer): The ID of the place associated with the group.
\n
type (integer): The type of the group (e.g., 0 for standard group).
\n
name (string): The name of the group.
\n
createdAt (string): The date and time when the group was created (ISO 8601 format).
\n
updatedAt (string): The date and time when the group was last updated (ISO 8601 format).
\n
subscribersCount (integer): The number of subscribers in the group.
\n
tags (array): A list of subgroups associated with the group.
\n
- id (integer): The unique identifier for the subgroup.
  \n
- groupId (integer): The ID of the group that the subgroup belongs to.
  \n
- name (string): The name of the subgroup.
  \n
- createdAt (string): The date and time when the subgroup was created (ISO 8601 format).
  \n
- updatedAt (string): The date and time when the subgroup was last updated (ISO 8601 format).
  \n
- subscribers (array): A list of subscribers associated with the subgroup, including their detailed information (e.g., name, email, parent details, etc.).
  \n
  - id (integer): The unique identifier for the subscriber.
    \n
  - firstName (string): The subscriber's first name.
    \n
  - lastName (string): The subscriber's last name.
    \n
  - email (string): The subscriber's email.
    \n
  - parent (object): Parent information for the subscriber (e.g., email, language preferences, etc.).
    \n
  - tags (array): A list of subgroups that the subscriber belongs to.
    \n
  \n
\n
membershipCard (null): Currently no membership card data associated with this group.
\n

\n","urlObject":{"protocol":"https","path":["v1","groups",":groupId"],"host":["user-api","messagespring","com"],"query":[],"variable":[{"description":{"content":"

(integer, required): The ID of the group you want to retrieve.

\n","type":"text/plain"},"type":"any","value":"{{group_id}}","key":"groupId"}]}},"response":[{"id":"5db58f07-0d73-43db-a5ed-64bb2f45d852","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://user-api.messagespring.com/v1/groups/:groupId","protocol":"https","host":["user-api","messagespring","com"],"path":["v1","groups",":groupId"],"variable":[{"key":"groupId","value":"{{group_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3387,\n \"placeId\": 2305,\n \"type\": 0,\n \"name\": \"English\",\n \"createdAt\": \"2023-01-28T17:08:02.000Z\",\n \"updatedAt\": \"2023-01-28T17:08:02.000Z\",\n \"subscribersCount\": 3,\n \"subgroups\": [\n {\n \"id\": 4445,\n \"groupId\": 3387,\n \"name\": \"English_1\",\n \"createdAt\": \"2023-01-28T17:08:02.000Z\",\n \"updatedAt\": \"2023-01-28T17:08:02.000Z\",\n \"subscribers\": [\n {\n \"id\": 347445,\n \"placeId\": 2305,\n \"avatar\": null,\n \"firstName\": \"Hod-en\",\n \"lastName\": \"Sus-en\",\n \"birthday\": \"1999-12-23\",\n \"uniqueId\": \"hs-en\",\n \"email\": \"poldet.assanangkornchai+hs.en@messagespring.com\",\n \"countryCode\": null,\n \"phoneNumber\": null,\n \"parent\": {\n \"id\": 30800,\n \"first_name\": \"Hod-en\",\n \"last_name\": \"Sus-en\",\n \"email\": \"poldet.assanangkornchai+hs.en@messagespring.com\",\n \"phone\": null,\n \"password\": \"omni-tmp-pass\",\n \"oauth_provider\": 0,\n \"oauth_provider_id\": null,\n \"profile_picture\": null,\n \"last_seen_date\": \"2024-09-06T07:37:02.000Z\",\n \"last_active_date\": \"2024-09-06T07:37:02.000Z\",\n \"created_at\": \"2023-01-24T04:04:30.000Z\",\n \"updated_at\": \"2024-09-06T07:37:02.000Z\",\n \"language\": {\n \"parent_id\": 30800,\n \"lng_id\": 1,\n \"languageDetails\": {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"nativeName\": \"English\"\n }\n }\n },\n \"createdAt\": \"2023-01-24T04:04:30.000Z\",\n \"updatedAt\": \"2023-01-24T04:04:30.000Z\",\n \"lastInvitationStatus\": 5,\n \"avatarCharacters\": \"HS\",\n \"subgroups\": [\n {\n \"id\": 4427,\n \"name\": \"Everyone\",\n \"group\": {\n \"id\": 3376,\n \"type\": 1,\n \"name\": \"Everyone\"\n }\n },\n {\n \"id\": 4445,\n \"name\": \"English_1\",\n \"group\": {\n \"id\": 3387,\n \"type\": 0,\n \"name\": \"English\"\n }\n }\n ],\n \"hasBadContact\": false\n },\n {\n \"id\": 444439,\n \"placeId\": 2305,\n \"firstName\": \"Poldet\",\n \"lastName\": \"Assanangkornchai\",\n \"email\": null,\n \"parent\": {\n \"id\": 30780,\n \"first_name\": \"Poldet\",\n \"last_name\": \"Assanangkornchai\",\n \"email\": \"poldet.assanangkornchai@messagespring.com\",\n \"password\": \"$2a$08$LPRbNQNDcBj0NjejnawpvuBBPHr1B3JjhocMI5JZroDRVm67v.G6G\",\n \"last_seen_date\": \"2024-09-11T04:31:47.000Z\",\n \"last_active_date\": \"2024-09-11T04:31:47.000Z\",\n \"language\": {\n \"parent_id\": 30780,\n \"lng_id\": 1,\n \"languageDetails\": {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"nativeName\": \"English\"\n }\n }\n },\n \"createdAt\": \"2023-08-11T03:13:16.000Z\",\n \"updatedAt\": \"2024-07-08T02:58:54.000Z\",\n \"lastInvitationStatus\": 5,\n \"subgroups\": [\n {\n \"id\": 4427,\n \"name\": \"Everyone\",\n \"group\": {\n \"id\": 3376,\n \"type\": 1,\n \"name\": \"Everyone\"\n }\n },\n {\n \"id\": 4445,\n \"name\": \"English_1\",\n \"group\": {\n \"id\": 3387,\n \"type\": 0,\n \"name\": \"English\"\n }\n }\n ],\n \"hasBadContact\": false\n },\n {\n \"id\": 445515,\n \"placeId\": 2305,\n \"firstName\": \"Preferred\",\n \"lastName\": \"English (default)\",\n \"email\": \"preffered.en.import@zbkchszl.mailosaur.net\",\n \"parent\": {\n \"id\": 108177,\n \"first_name\": \"Preferred\",\n \"last_name\": \"English (default)\",\n \"email\": \"preffered.en.import@zbkchszl.mailosaur.net\",\n \"language\": {\n \"parent_id\": 108177,\n \"lng_id\": 1,\n \"languageDetails\": {\n \"id\": 1,\n \"code\": \"en\",\n \"name\": \"English\",\n \"nativeName\": \"English\"\n }\n }\n },\n \"createdAt\": \"2023-08-31T08:20:37.000Z\",\n \"updatedAt\": \"2024-06-21T07:35:19.000Z\",\n \"subgroups\": [\n {\n \"id\": 4427,\n \"name\": \"Everyone\",\n \"group\": {\n \"id\": 3376,\n \"type\": 1,\n \"name\": \"Everyone\"\n }\n },\n {\n \"id\": 4445,\n \"name\": \"English_1\",\n \"group\": {\n \"id\": 3387,\n \"type\": 0,\n \"name\": \"English\"\n }\n }\n ],\n \"hasBadContact\": false\n }\n ],\n \"users\": []\n }\n ],\n \"membershipCard\": null\n}"}],"_postman_id":"72b3a12c-68d5-4c92-92d3-91054ec0499d"},{"name":"Add Subgroup to Group","event":[{"listen":"test","script":{"id":"860e17f5-45c7-4ac5-941f-b2fe291533db","exec":[""],"type":"text/javascript","packages":{}}}],"id":"b1549d8f-982e-43d1-93e4-bd6354232efd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Bangkok\"\n}"},"url":"https://user-api.messagespring.com/v1/groups/:groupId/tags","description":"

This endpoint allows you to add a new subgroup to a specified group.

Request Body

name (string, required): The name of the subgroup to be added.

Response Body

On success, the response will include the details of the newly added subgroup, including its unique identifier and name

\n","urlObject":{"protocol":"https","path":["v1","groups",":groupId","tags"],"host":["user-api","messagespring","com"],"query":[],"variable":[{"description":{"content":"

(integer, required): The ID of the group you want to retrieve.

\n","type":"text/plain"},"type":"any","value":"{{groupId}}","key":"groupId"}]}},"response":[{"id":"0cc05902-ef23-4f94-855c-28122fb0b34b","name":"201","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Bangkok\"\n}"},"url":{"raw":"https://user-api.messagespring.com/v1/groups/:groupId/tags","protocol":"https","host":["user-api","messagespring","com"],"path":["v1","groups",":groupId","tags"],"variable":[{"key":"groupId","value":"{{groupId}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 128889\n}"}],"_postman_id":"b1549d8f-982e-43d1-93e4-bd6354232efd"}],"id":"bccd882d-9dff-4ae8-90b3-8ee393ffdc63","_postman_id":"bccd882d-9dff-4ae8-90b3-8ee393ffdc63","description":""}]}