{ "openapi": "3.0.1", "info": { "title": "PBT API documentation", "version": "v1", "x-logo": { "url": "https://c2w-dev-app-vcf.s3.amazonaws.com/mediafiles/PBT_LARGE.png", "backgroundColor": "#FFFFFF", "altText": "PBT API" }, "description": "# Getting Started\n\n## Overview\n\nThe PBT platform provides you with an effortless means to extend your application’s ability to communicate through SMS, MMS and WhatsApp. Our API platform has been organized to help simplify the process of integrating your applications.\n\n## Planning your Integration\n\nBefore any messages can be sent, the account needs to be properly setup.\n\nYou should receive your credentials from your Implementation Specialist, in addition to the following properties that you will need as input for your API calls:\n\n- AccountId\n- OrgunitId\n- GroupId\n\nOnce you have your credentials, you are ready to start your integration to send messages.\n\n## Communication Codes\n\nYour PBT account includes a dedicated communication code which you will send and receive messages over. This can be a 5 or 6 digit dedicated short code and/or a 10 digit 10DLC.\n\nAccounts with dedicated short codes also include a 10DLC for fallback delivery.\n\nFor your integration workflow testing you will also have an additional 10DLC for sandbox use that will not expire.\n\n## API Access\n\n| Environment | API URL | UI URL | Token URL |\n| ----------- | --------------------------------- | --------------------------------- |----------------------------------|\n| Sandbox | https://api-qa.poweredbytext.com | https://c2w-qa.poweredbytext.com | https://login-qa.poweredbytext.com/connect/token | \n| Production | https://api.poweredbytext.com | https://c2w.poweredbytext.com | https://login.poweredbytext.com/connect/token |\n\n## Authentication\n\nOAuth is an open authorization protocol which shares resource with applications. OAuth offers an additional and separate way of providing security controls. Instead of sharing your username and password with an application and granting full access to your account, OAuth enables scoped access to your resources. OAuth 2.0 uses Access Tokens. An Access Token is a token of data which has the authorization to access the your resources.\n\n### OAuth 2.0 Flow\n\n1. Send a `POST` request to the TokenURL given in the details below along with the Client ID and Secret.\n2. This request will authorize the user and send the Access Token in response.\n3. Send the received Access Token in header of the API request with prefix `bearer`.\n\n**Token URL:** `'https://login.poweredbytext.com/connect/token'`\n\n**HTTP Request:** `POST`\n\n| Details | Values |\n| ------------- | --------------------------------- |\n| grant_type | Client Credentials |\n| token_name | \"your-token-name\" (Optional) |\n| client_id | \"your-clientID-string-value\" |\n| client_secret | \"your-client-secret-string-value\" |\n\n**Response**\n\n| Details | Values |\n| ------------ | --------------------------------------------- |\n| token_name | Token name if that was passed in the request. |\n| access_token | String value of the token. |\n| token_type | Bearer type token will be returned. |\n| expires_in | Gives the time when the token expires. |\n\n**Example**\n\nHttpRequest\n\n```c#\nstring url = \"[https://login.poweredbytext.com/connect/token](https://login.poweredbytext.com/connect/token)\";\nvar requestData = new List>\n {\n new KeyValuePair(\"grant_type\",\"client_credentials\"),\n new KeyValuePair(\"client_id\",\"your-clientID-string-value\"),\n new KeyValuePair(\"client_secret\",\"your-client-secret-string-value\"),\n };\nvar tokenResponse = await HttpClient.PostAsync(url, new FormUrlEncodedContent(requestData));\n```\n\nResponse\n\n```json\n{\n \"access_token\": \"your-access-token\",\n \"expires_in\": \"3600\",\n \"token_type\": \"Bearer\"\n}\n```\n\n# General\n\n## API Usage Limits\n\nTo ensure the PBT platform API is available to all customers, certain limits have been put in place.\n\nThe limits on the total calls and the rate at which the calls can be made protect the system from receiving more data than it can handle, and ensures an equitable distribution of system resources. These limits ensure that individual actions cannot adversely impact other API users.\n\n**PBT balances load by imposing concurrent (parallel) requests limit.**\n\nAPI usage limitations are considered per API Key account.\n\n## Concurrent (parallel) requests limit\n\nThere is a limit on the number of requests that a user can execute concurrently.\n\n| Send Message Request Limit: 10x100 |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| An account can send up to 10 parallel requests or use multiple threads at a time. For sending messages, a limit of 100 messages per request is allowed |\n\n## Blacklisting\n\nIf your application abuses the rate limits we will blacklist it. _If you are blacklisted you will be unable to get a response from the PBT API._ If your application has been blacklisted and you believe there has been an error you can contact support@poweredbytext.com.\n\nIf send message request attemt is made with invalid Status URL for 200 times, then status call URL is blacklisted and you will not be able to use it in future. For unblocking the status URL please contact support@poweredbytext.com.\n\n## Compliance Requirements\n\nDocumented consent, along with help and stop instructions, are required to send ongoing messages for each phone number subscribed to a group. The PBT platform handles these compliance requirements for each `mobileNo` in each group and orgunit they are a subscriber of. These requirements cannot be modified or bypassed.\n\n### Opt-in\n\n| Method | Description |\n| ------- | ------------------------------------------------------------------------------------------- |\n| Keyword | Self-initiated opt-in by a `mobileNo` sending a specific keyword to your communication code |\n| API | System-initiated opt-in for a specific `groupId` |\n\n**Default Opt-int Message**\n\n> Welcome to the {GrpName} texting group! \n> Msg&Data Rates May Apply. \n> Msgs vary by acct/pref. \n> To optout reply STOP or HELP for info.\n\n### Opt-out\n\n| Method | Description |\n| ------- | ------------------------------------------------------------------------------------------------------ |\n| STOP | Self-initiated opt-out for a specific group by a `mobileNo` sending STOP to your communication code |\n| STOPALL | Self-initiated opt-out for an entire orgunit by a `mobileNo` sending STOPALL to your communication code |\n| API | System-initiated opt-out for a specific `groupId` |\n\n**Default STOP Message**\n\n>You won't rcv {GrpName} text msgs. \n>Other {OrgName} text msgs continue if subscribed. \n>To opt back in reply {KeywordName}. \n>To end all txt msgs reply STOPALL\n\n\n\n**Default STOPALL Message**\n\n>All text subscriptions have been removed and you will no longer rcv text msgs from {OrgName}. \n\n\n## Status Codes\n\n| STATUS CODE | STATUS DESCRIPTION API | STATUS DESCRIPTION UI | STATUS EXPLANATION |\n| :--- | :--- | :--- | :--- |\n| 1600 | Message was successfully delivered | Delivered | The message has successfully reached the recipient's handset. This is the final confirmation of delivery. |\n| 1699 | Your message has been queued in the Platform | Message Queued | The message has been received by our platform and is currently in a queue awaiting processing before being sent to the carrier. This is a normal intermediate step. |\n| 1701 | Message was successfully delivered to the carrier | Sent to carrier | The message has been successfully transmitted from our platform to the recipient's mobile phone carrier (e.g., Verizon, AT&T). The carrier is now responsible for delivering it to the recipient's device. |\n| 1702 | The message has been queued for delivery to the carrier | Queued to carrier | The message is in our system's queue and is waiting to be dispatched to the recipient's mobile phone carrier. This usually happens very quickly. |\n| 1710 | Stopfail - Not a Subscriber | Stopfail - Not a Subscriber | This individual has not provided consent (opted-in) to receive messages. Sending messages without prior consent can violate regulations. An opt-in is required before any future messages can be delivered. |\n| 1711 | Stopfail - Inactive Subscriber | Stopfail - Inactive Subscriber | This individual had previously opted-in but has since unsubscribed from communications (e.g., by replying 'STOP'). Their preference to not receive messages should be respected. |\n| 1712 | Stopfail - Blocked Subscriber | Stopfail - Blocked Subscriber | This phone number is blocked from receiving messages. The block may have been initiated by the recipient through their carrier, or by the carrier itself due to perceived spam or other issues. |\n| 1713 | StopFail - Carrier Not Supported | StopFail - Carrier Not Supported | The recipient's mobile phone carrier may not support the specific type of message being sent (e.g., short code messages), or there might be a temporary technical issue with that carrier preventing delivery. |\n| 1714 | StopFail - Invalid Number | StopFail - Invalid Number | The phone number provided appears to be incorrect, improperly formatted, or is not a valid, callable mobile number. It is advisable to verify the number and remove it from the list if it is confirmed as incorrect. |\n| 1715 | StopFail - Landline Number | StopFail - Landline Number | This phone number is registered as a landline, which typically cannot receive SMS/text messages. The number should be removed from mobile messaging lists to avoid further failed attempts. |\n| 1800 | The message was undeliverable and no explanation was provided from the carrier | Undeliverable | The message could not be delivered to the recipient's handset, and the carrier did not provide a specific reason for the failure. This can sometimes be a temporary issue; a retry may be successful, but persistent failures warrant investigation. |\n| 1801 | The carrier has blocked SMS traffic to the handset | Blocked Number | The recipient's mobile carrier has actively blocked messages to this phone number. This could be due to recipient request, unpaid bills, or carrier policies against certain types of traffic. |\n| 1803 | The phone number is no longer in service | Deactivated Number | This phone number is no longer active or in use with any carrier. It should be removed from messaging lists to maintain list hygiene and avoid unnecessary sending costs. |\n| 1804 | No message content provided, message was too long, or message contained invalid characters | Invalid content | The message failed because it was either empty, exceeded the maximum character limit for a single SMS, or contained special characters or symbols that are not permitted by carriers. The message content should be reviewed and corrected. |\n| 1805 | The phone number belongs to a country that is not supported | Unsupported Country | This phone number is associated with a country to which messages currently cannot be delivered through this platform, possibly due to routing limitations or regulatory restrictions. |\n| 1806 | The carrier was unable to forward the message to the handset | Unable to forward | The recipient's mobile carrier accepted the message but was subsequently unable to deliver it to the recipient's actual device. This could be due to temporary issues like the device being off, out of signal range, or having a full inbox. |\n| 1808 | The carrier ID provided was invalid | Invalid carrier | An issue occurred in identifying the recipient's mobile carrier, or the carrier information associated with the number was incorrect or outdated. This may resolve automatically if the recipient recently changed carriers and systems update. |\n| 1809 | Carrier Not Found | Carrier Not Found | A mobile phone carrier could not be definitively identified for this number. This often indicates the number is invalid, inactive, or from a region with incomplete carrier data. |\n| 1810 | Subscriber insufficient credits | Subscriber insufficient credits | The recipient has a prepaid mobile plan and does not have sufficient funds or credits on their account with their mobile carrier to receive the incoming message. |\n| 1811 | Invalid destination address | Invalid destination address | The phone number provided for the recipient is not valid or is formatted incorrectly, preventing the system from routing the message. The number should be double-checked for accuracy. |\n| 1812 | Message content blocked | Block - Review | The content of the message was flagged and blocked by a carrier or an internal filtering system. This usually happens if the content is suspected of being spam, phishing, or containing prohibited keywords or URL patterns. |\n| 1813 | Message blocked, unsubscribe | Block - Unsubscribe | The message was blocked because the recipient has previously opted out of receiving messages (e.g., by replying 'STOP') or their number is on a global or internal do-not-contact list. Their unsubscribe preference must be honored. |\n| 1814 | Blocked due multiple identical or similar messages within an hour to the same subscriber | Flood Filter | An excessive number of identical or very similar messages were sent to this recipient in a short timeframe, triggering an anti-spam (flood) filter. This is a common carrier protection measure. Retry sending after a waiting period. |\n| 1815 | Request failed due to subscriber, equipment, network, or content issues; or due to invalid request parameters or access restrictions. | Subscriber Network Error | Typically, this indicates that the subscriber or recipient of the message is unknown or not recognized by the network. |\n| 1816 | Invalid destination address. | Invalid destination address | The number is valid, but the network reported the subscriber as unavailable at the time of the attempt, typically because the handset was powered off, out of coverage, or otherwise unreachable. Despite the description shown, this does not mean the number is bad, and it should not be removed from the list. Retrying later is often successful. |\n| 1817 | Request failed: destination/account issues, limits exceeded, or content/system errors. | Request failed: destination/account issues, limits exceeded, or content/system errors | This is a general rejection code that covers several possible causes: an invalid destination number, an account or provisioning problem, a sending limit that has been reached, or content rejected by the carrier or the platform. |\n| 1818 | Message was not delivered due to 10DLC operator limit. | Message was not delivered due to 10DLC operator limit | The message was not delivered because the sending 10DLC number reached a throughput limit set by the carrier. Carriers cap daily message volume for 10DLC numbers based on the campaign's registered trust score and brand vetting. Sending usually resumes when the limit resets, and raising the cap requires changes to the campaign registration. |\n| 1819 | Validity period over and has expired with the appropriate error code. | Validity period over and has expired with the appropriate error code. | The message remained pending for its full validity period and expired before the carrier could deliver it. This usually means the handset was powered off, out of coverage, or otherwise unreachable for an extended period. The message will not be retried automatically and must be resent if delivery is still needed. |\n| 2004 | System Error | Temporary system error by carrier | The recipient's mobile phone carrier experienced a temporary internal technical problem or outage that prevented the delivery of the message. Retrying later may be successful. |\n| 2008 | A provided parameter was invalid | Invalid parameter | A technical parameter required for sending the message (e.g., an incorrect sender ID format or other API setting) was incorrect or missing. This is typically an internal system or configuration issue that needs to be addressed by the sender's technical team. |\n| 2009 | Account misconfiguration detected | Config error | An issue exists with the sending account's setup or its configuration for transmitting messages, such as incorrect credentials or service provisioning. Support should be contacted to resolve this. |\n| 2010 | Carrier not supported by aggregator / No delivery route defined for carrier | Invalid route | A delivery route to the recipient's specific mobile phone carrier is not available through the current network aggregators. This means messages cannot be sent to this carrier at this time. |\n| 2011 | Carrier TPS Rate Exceeded | Carrier TPS Rate Exceeded | Messages are being sent at a rate (Transactions Per Second) that exceeds the limits allowed by the recipient's carrier. Sending will typically be automatically throttled (slowed down) or retried by the platform. |\n| 2012 | Carrier Daily Volume Exceeded | Carrier Daily Volume Exceeded | The total number of messages permitted to be sent to or through this specific carrier for the day has been reached. Sending should be attempted again on the following day or when the volume cap resets. |\n| 2172 | Campaign information is not provisioned for this carrier or is not active | Campaign not provisioned | The specific campaign ID or type of message being sent (e.g., related to a particular 10DLC campaign registration) is not correctly provisioned or recognized for this recipient's carrier, or the campaign itself is not currently active. |\n| 2400 | Message undeliverable due to restriction in communication code used | LC_Replaced | The message could not be sent using the originally intended communication channel or short code due to a restriction (e.g., carrier block on that short code). An alternative sending method, such as a long code (LC), may have been automatically utilized if configured. |\n\n\n## Error Codes\n\n| ERROR CODE. | ERROR DESCRIPTION - RESPONSE TO API REQUEST | ERROR DESCRIPTION IN UI | ACTION REQUIRED |\n| ------------ | -------------------------------------------- | ------------------------ | --------------- |\n| g.1200 | Request successful | Request successful | |\n| g.1400 | Bad request | Bad request | |\n| g.1401 | Unauthorized | Unauthorized | |\n| g.1403 | Forbidden | Forbidden | |\n| g.2201 | Created successfully | Created successfully | |\n| g.2400 | Bad request | Bad request | |\n| g.3200 | Updated successfully | Updated successfully | |\n| g.4200 | Deleted successfully | Deleted successfully | |\n| g.4400 | Bad request | Bad request | |\n| g.4404 | Resource not found | Resource not found | |\n| ge.1001 | Please enter name | Please enter name | Enter Name |\n| ge.1007 | Group name already exist | Group name already exist | Give a different Group name |\n| ge.1115 | Cannot change activity group to info group | Cannot change activity group to info group | |\n| ge.1116 | At least one user must be associated with a orgunit | At least one user must be associated with a orgunit | Select atleast one user |\n| ge.1119 | Tag should not allow more then 15 or special character | Tag should not allow more then 15 or special character | Enter tag in proper format |\n| ge.1120 | Keywords should not allow more then 12 or special character | Keywords should not allow more then 12 or special character | Enter keyword in proper format |\n| ge.1121 | Add prefix in keywords | Add prefix in keywords | |\n| ge.1123 | Account status must be active | Account status must be active | |\n| ge.1131 | Please enter OrgunitId | Please enter OrgunitId | Enter orgunitId |\n| ge.2201 | Created successfully | Created successfully | |\n| ms.1028 | Please enter group id. | Please enter group id. | |\n| ms.1029 | Please enter subscriber number | Please enter subscriber number | |\n| ms.1033 | Type is invalid | Type is invalid | |\n| sc.1004 | Please enter long URL | Please enter long URL | |\n| sc.1010 | Please enable short url setting | Please enable short url setting | Enable Short URL from settings: https://c2w.poweredbytext.com/settings/utilities/m-clicks | \n| sc.1011 | URL marked as do not shorten | URL marked as do not shorten | |\n| sc.1012 | Account is not active | Account is not active | |\n| su.1137 | Number invalid | Number invalid | |\n| co.1010 | File not found | File not found | |\n| co.1050 | Please enter valid image Format | Please enter valid image Format | |\n| li.1001 | Please enter valid list id | Please enter valid list id | |\n| li.1002 | List not found | List not found | |\n| li.1003 | Failed to refresh list | Failed to refresh list | |\n| li.1004 | This list does not contain any subscribers | This list does not contain any subscribers | |\n| li.1005 | Segments can only be sent to lists with a Completed status | Segments can only be sent to lists with a Completed status | |\n| li.1006 | List already exists | List already exists | |\n| li.1007 | List name cannot be empty | List name cannot be empty | |\n| li.1008 | Failed to create list | Failed to create list | |\n| li.1009 | File URL must be provided to create the list | File URL must be provided to create the list | |\n| li.1010 | Please enter valid subscribers | Please enter valid subscribers | |\n| li.1011 | Subscribers Not Found | Subscribers Not Found | |\n| li.1012 | Maximum 1000 Subscribers only allowed at a time | Maximum 1000 Subscribers only allowed at a time | |\n| ph.1005 | File not found | File not found | |\n\n## General Error Codes\n\n| \tERROR CODE | ERROR DESCRIPTION |\n| ----------- | ----------------- |\n| **2XX** | **Successful** |\n| 200 | Request successful |\n| 201 | Resource created successfully |\n| 202 | Resource verified succesfully |\n| **4XX** | **Client Error** |\n| 400 | Bad Request |\n| 401 | Unauthorized |\n| 403 | Access Denied. You do not have permission to perform this action. |\n| 404 | Resource not found |\n| 405 | Method Not Allowed |\n| 407 | Proxy Authentication Required |\n| 408 | Request Timeout |\n| 415 | Unsupported Media Type | \n| **5XX** | **Server Error** |\n| 500 | Internal Server Error | \n| 501 | Not Implemented |\n| 502 | Bad Gateway | \n| 503 | Service Unavailable |\n| 504 | Gateway Timeout |" }, "tags": [ { "name": "Orgunit", "description": "Orgunit represents a separate “brand” within your PBT account. These are separate identities or entities, not sub-organizations or people groups from your organization. Your account may have multiple orgunits. Each orgunit has a unique `orgunitID` and maintains separate compliance, consent, and subscriber status.\r\n\r\n> **Examples:**
\r\n> MyChurch North, MyChurch South, MyChurch Central
\r\n> KPBT-22, PBTV-TX, KPBT-Dallas
\r\n>ABC TX, ABC AZ, ABC FL" }, { "name": "Account", "description": "Your Account is the top-level of your PBT service. It represents the total organization, subscription details, billing, and user management. Your account has a unique `accountID` assigned." }, { "name": "Group", "description": "Each orgunit is populated with groups. Groups are the segmentation level where messages are sent and received and subscriber lists are maintained. Each group is given a unique `groupID`, and combined with the `orgunitID` and `accountID` give you the coordinates needed to run your processes.\nGroups are now categorized into three distinct types:\n 1. SUBSCRIPTION: Standard groups used to broadcast SMS and MMS communications to opted-in subscribers.\n 2. INFO: Specialized groups designed exclusively for information-only keywords; these groups cannot maintain subscriber records.\n 3. WHATSAPP: Dedicated groups utilized for delivering WhatsApp-specific messages to subscribers." }, { "name": "Keywords", "description": "Keywords are strings that can be assigned within groups to initiate optin, deliver SMS responses, or trigger other actions." }, { "name": "Contact", "description": "A contact represents a person and contains identifiable information associated with a mobile number, like name, email, age, etc. If a matching subscriber is found in a group, the information found in the contact is displayed within the group and subscriber details. The information on a contact record can be used for merge variables when composing a message. \n\n Example: {{fname}} = Matthew" }, { "name": "Subscriber", "description": "A subscriber represents a single mobile number added to a specific group for SMS communication and can have a status of active or inactive. The same subscriber number can be part of multiple groups, orgunit, or accounts. Active and inactive status is maintained for the subscriber in each group independently." }, { "name": "Send", "description": "**Send Message to Subscribers**\r\n\r\nSend Message to Subscribers sends a single, one-time message to one or more subscribers in a Group.\r\n\r\n| Message Type | Description |\r\n| ------------ | --------------------------------------------------------------------------------------------------------- |\r\n| Broadcast | Send to the entire group. |\r\n| Test | Send test message to test user. |\r\n| Twoway | Send to a single subscriber for a direct one-to-one conversation with your organization's representative. |\r\n| Unicast | Send to a single subscriber or a set of subscribers to be sent in message params. |" }, { "name": "Segment List", "description": "Manages targeted subscriber lists created from custom segment files or external data sources. Segment lists allow you to organize, update, and maintain specific subsets of subscribers to be used directly for targeted audience delivery in the Segment Send Message endpoints." } ], "paths": { "/accounts/{accountId}": { "get": { "tags": [ "Account" ], "summary": "Get Account based on AccountId", "description": "Retrieves the top-level profile configuration, subscription plan, and administrative metadata for a specific PBT account. The response includes core details such as registration credentials, geographic settings, account status flags, and default automated responses.", "parameters": [ { "name": "accountId", "in": "path", "description": "accountId", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/accounts/{accountId}' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/accounts/{accountId}\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/{accountId}\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterAccountExternalApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterAccountExternalApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponse`1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponse`1" } } } } } } }, "/accounts/{accountId}/templates": { "post": { "tags": [ "Account" ], "summary": "Add Account Template", "description": "Templates are pre-saved messages that can be sent at any time simply by \npassing a `templateId` to the Message API. There are two types of templates:\n- Text Templates: Used to send SMS.\n- Media Templates: Used to send MMS.\n\nYou can create an account-level template that applies directly to newly \ncreated orgunits and groups.\n\nTo create a Media Template, first call the 'Upload Media File' API in the \nsend section, then pass the 'mediaDetails' object from that response into \nthe template object.\n", "parameters": [ { "name": "accountId", "in": "path", "description": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplateRequestParams" }, "examples": { "SMSTemplate": { "summary": "Text-only Template.", "value": { "name": "Send Welcome Message!", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey" } }, "Mediatemplate": { "summary": "Media Template", "value": { "name": "Welcome Message with Media", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey", "mediaDetails": { "mediaPath": [ { "fileName": "welcome_banner", "extension": ".png", "fileSaveId": "fs_987654321", "mimetype": "image/png", "url": "https://example.com/assets/welcome_banner.png" } ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/accounts/{accountId}/templates' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '{\n \"name\": \"string\",\n \"message\": \"string\"\n}'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Post, \"https://api.poweredbytext.com/accounts/{accountId}/templates\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar content = new StringContent(\"{\\r\\n \\\"name\\\": \\\"string\\\",\\r\\n \\\"message\\\": \\\"string\\\",\\r\\n}\", null, \"application/json\");\nrequest.Content = content;\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/{accountId}/templates\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"message\": \"string\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponseExternalApiResponseNew" }, "example": { "appCode": "g.2201", "message": "Created successfully", "isError": false, "data": { "id": "688452a9-287d-4397-a0fb-9b818eaea897" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } }, "get": { "tags": [ "Account" ], "summary": "Get All Account Templates", "description": "Retrieves a paginated list of account-level message templates. Supports global search filtering by template name or body text, sorting options, and direct lookup using a specific template ID.", "parameters": [ { "name": "accountId", "in": "path", "description": "accountId", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search for template details by passing the template name or part of message body.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "sorting", "in": "query", "description": "Retrieve a list of templates sorted by name.", "schema": { "type": "string", "default": "Ascending", "enum": [ "Ascending", "Descending" ] } }, { "name": "templateId", "in": "query", "description": "Get any template details be passing the templateId.", "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/accounts/{accountId}/templates' \\\n--header 'Authorization: Bearer abc'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/accounts/{accountId}/templates\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/{accountId}/templates\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplatePaginatedResponse3ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "put": { "tags": [ "Account" ], "summary": "Update Account Template", "description": "Modifies the details of an existing account-level message template. This endpoint allows updates to the template name, body text, and the addition/modification of media properties to convert a standard text template into a Media Template (MMS).", "parameters": [ { "name": "accountId", "in": "path", "description": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplateEditRequestParams" }, "examples": { "SMSTemplate": { "summary": "Text-only Template.", "value": { "id": "688452a9-287d-4397-a0fb-9b818eaea897", "name": "Send Welcome Message!", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey" } }, "Mediatemplate": { "summary": "Media Template", "value": { "id": "688452a9-287d-4397-a0fb-9b818eaea897", "name": "Welcome Message with Media", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey", "mediaDetails": { "mediaPath": [ { "fileName": "welcome_banner", "extension": ".png", "fileSaveId": "fs_987654321", "mimetype": "image/png", "url": "https://example.com/assets/welcome_banner.png" } ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request PUT 'https://api.poweredbytext.com/accounts/{accountId}/templates' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '{\n \"id\": \"string\",\n \"name\": \"string\",\n \"message\": \"string\"\n}'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Put, \"https://api.poweredbytext.com/accounts/{accountId}/templates\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar content = new StringContent(\"{\\r\\n \\\"id\\\": \\\"string\\\",\\r\\n \\\"name\\\": \\\"string\\\",\\r\\n \\\"message\\\": \\\"string\\\",\\r\\n}\", null, \"application/json\");\nrequest.Content = content;\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/{accountId}/templates\",\n \"method\": \"PUT\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify({\n \"id\": \"string\",\n \"name\": \"string\",\n \"message\": \"string\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.3200", "message": "Updated successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3400", "message": "Bad Request", "isError": true } } } } } } }, "/accounts/{accountId}/templates/{templateId}": { "delete": { "tags": [ "Account" ], "summary": "Delete Account Template", "description": "Permanently deletes a specific account-level message template. Once removed, this template will no longer be available to send message. It will no longer be added to newly created orgunit and groups.", "parameters": [ { "name": "accountId", "in": "path", "description": "accountId", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --globoff --request DELETE 'https://api.poweredbytext.com/accounts/{accountId}/templates/{templateId}' \\\n--header 'Authorization: Bearer abc'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Delete, \"https://api.poweredbytext.com/accounts/{accountId}/templates/{templateId}\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/{accountId}/templates/{templateId}\",\n \"method\": \"DELETE\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.4200", "message": "Deleted successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.4400", "message": "Bad Request", "isError": true } } } } } } }, "/orgunit": { "get": { "tags": [ "Orgunit" ], "summary": "Get Orgunit", "description": "Retrieves a paginated list of orgunit (brands) associated with your account. Supports search filtering by brand name, standard pagination configuration, and filtering for the default orgunit.", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Filters the orgunit by matching alphanumeric characters against the orgunit name." }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 }, "description": "Specifies the page index of the results to retrieve. Must be greater than or equal to 1." }, { "name": "pageSize", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 }, "description": "Controls the maximum number of orgunit returned per page. Accepts values between 1 and 1000." }, { "name": "defaultOrgunit", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When set to true, filters the results to only return the primary or default orgunit associated with the account." } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/orgunit?pageNumber=1&pageSize=10' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit?pageNumber=1&pageSize=10\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit?pageNumber=1&pageSize=10\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgunitResponseListPaginatedResponseExternalApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectExternalApiResponse" } } } } } }, "post": { "tags": [ "Orgunit" ], "summary": "Create new Orgunit", "description": "Provisions a new organization unit (brand) within your PBT account. This endpoint configures the base identification properties, communication profiles, and physical address metadata for the brand, automatically generating a unique campus identifier upon success.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgunitParam" }, "example": { "name": "Orgunit Name", "email": "orgunit@company.com", "contactNo": "1987xxxxx00", "imageURL": "any-valid-imageurl.com", "details": "Orgunit details", "address": { "address1": "Primary address lane details", "state": "Texas", "postalCode": "75201", "countryCode": "US" } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.poweredbytext.com/orgunit' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"contactNo\": \"string\",\n \"imageURL\": \"string\",\n \"details\": \"string\",\n \"address\": {\n \"address1\": \"string\",\n \"state\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\"\n }\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"email\"\": \"\"user@example.com\"\",\n\" + \"\\n\" +\n@\" \"\"contactNo\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"imageURL\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"details\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"address\"\": {\n\" + \"\\n\" +\n@\" \"\"address1\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"state\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"countryCode\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" }\n\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"contactNo\": \"string\",\n \"imageURL\": \"string\",\n \"details\": \"string\",\n \"address\": {\n \"address1\": \"string\",\n \"state\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\"\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampusIdResponseExternalApiResponseNew" }, "example": { "data": { "campusId": "4f56e511-f710-4b4e-ac0c-fbf5e55334d8" }, "appCode": "g.2201", "message": "Create Successfuly", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } } }, "/orgunit/{orgunitId}": { "put": { "tags": [ "Orgunit" ], "summary": "Update Orgunit Details", "description": "Modifies the operational profile, administrative contact details, and physical address metadata for an existing orgunit(brand). Updates made through this endpoint immediately apply to the brand identity.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgunitParam" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request PUT 'https://api.poweredbytext.com/orgunit/{orgunitId}' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"contactNo\": \"string\",\n \"imageURL\": \"string\",\n \"details\": \"string\",\n \"address\": {\n \"address1\": \"string\",\n \"state\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\"\n }\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"email\"\": \"\"user@example.com\"\",\n\" + \"\\n\" +\n@\" \"\"contactNo\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"imageURL\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"details\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"address\"\": {\n\" + \"\\n\" +\n@\" \"\"address1\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"state\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"countryCode\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" }\n\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}\",\n \"method\": \"PUT\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"contactNo\": \"string\",\n \"imageURL\": \"string\",\n \"details\": \"string\",\n \"address\": {\n \"address1\": \"string\",\n \"state\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\"\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n}); \n" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.3200", "message": "Updated successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3400", "message": "Bad Request", "isError": true } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3401", "message": "Unauthorized", "isError": true } } } } } } }, "/orgunit/{orgunitId}/templates": { "post": { "tags": [ "Orgunit" ], "summary": "Add Orgunit Template", "description": "Templates are pre-saved messages that can be sent at any time simply by \npassing a `templateId` to the Message API. There are two types of templates:\n- Text Templates: Used to send SMS.\n- Media Templates: Used to send MMS.\n\nYou can create an orgunit-level template that applies directly to newly \ncreated groups.\n\nTo create a Media Template, first call the 'Upload Media File' API in the \nsend section, then pass the 'mediaDetails' object from that response into \nthe template object.\n", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplateRequestParams" }, "examples": { "SMSTemplate": { "summary": "Text-only Template.", "value": { "name": "Send Welcome Message!", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey" } }, "Mediatemplate": { "summary": "Media Template", "value": { "name": "Welcome Message with Media", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey", "mediaDetails": { "mediaPath": [ { "fileName": "welcome_banner", "extension": ".png", "fileSaveId": "fs_987654321", "mimetype": "image/png", "url": "https://example.com/assets/welcome_banner.png" } ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/templates' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '{\n \"name\": \"string\",\n \"message\": \"string\"\n}'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Post, \"https://api.poweredbytext.com/orgunit/{orgunitId}/templates\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar content = new StringContent(\"{\\r\\n \\\"name\\\": \\\"string\\\",\\r\\n \\\"message\\\": \\\"string\\\",\\r\\n}\", null, \"application/json\");\nrequest.Content = content;\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/templates\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"message\": \"string\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponseExternalApiResponseNew" }, "example": { "appCode": "g.2201", "message": "Created successfully", "isError": false, "data": { "id": "688452a9-287d-4397-a0fb-9b818eaea897" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } }, "get": { "tags": [ "Orgunit" ], "summary": "Get All Orgunit Templates", "description": "Retrieves a paginated list of orgunit-level message templates. Supports global search filtering by template name or body text, sorting options, and direct lookup using a specific template ID.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search for template details by passing the template name or part of message body.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "sorting", "in": "query", "description": "Retrieve a list of templates sorted by name.", "schema": { "type": "string", "default": "Ascending", "enum": [ "Ascending", "Descending" ] } }, { "name": "templateId", "in": "query", "description": "Get any template details be passing the templateId.", "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/templates' \\\n--header 'Authorization: Bearer abc'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/templates\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/templates\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplatePaginatedResponse3ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "put": { "tags": [ "Orgunit" ], "summary": "Update Orgunit Template", "description": "Modifies the details of an existing orgunit-level message template. This endpoint allows updates to the template name, body text, and the addition/modification of media properties to convert a standard text template into a Media Template (MMS).", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplateEditRequestParams" }, "examples": { "SMSTemplate": { "summary": "Text-only Template.", "value": { "id": "688452a9-287d-4397-a0fb-9b818eaea897", "name": "Send Welcome Message!", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey" } }, "Mediatemplate": { "summary": "Media Template", "value": { "id": "688452a9-287d-4397-a0fb-9b818eaea897", "name": "Welcome Message with Media", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey", "mediaDetails": { "mediaPath": [ { "fileName": "welcome_banner", "extension": ".png", "fileSaveId": "fs_987654321", "mimetype": "image/png", "url": "https://example.com/assets/welcome_banner.png" } ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request PUT 'https://api.poweredbytext.com/orgunit/{orgunitId}/templates' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '{\n \"id\": \"string\",\n \"name\": \"string\",\n \"message\": \"string\"\n}'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Put, \"https://api.poweredbytext.com/orgunit/{orgunitId}/templates\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar content = new StringContent(\"{\\r\\n \\\"id\\\": \\\"string\\\",\\r\\n \\\"name\\\": \\\"string\\\",\\r\\n \\\"message\\\": \\\"string\\\",\\r\\n}\", null, \"application/json\");\nrequest.Content = content;\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/templates\",\n \"method\": \"PUT\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify({\n \"id\": \"string\",\n \"name\": \"string\",\n \"message\": \"string\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.3200", "message": "Updated successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3400", "message": "Bad Request", "isError": true } } } } } } }, "/orgunit/{orgunitId}/templates/{templateId}": { "delete": { "tags": [ "Orgunit" ], "summary": "Delete Orgunit Template", "description": "Permanently deletes a specific orgunit-level message template. Once removed, this template will no longer be available to send message. It will no longer be added to newly created groups.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --globoff --request DELETE 'https://api.poweredbytext.com/orgunit/{orgunitId}/templates/{templateId}' \\\n--header 'Authorization: Bearer abc'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Delete, \"https://api.poweredbytext.com/orgunit/{orgunitId}/templates/{templateId}\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/templates/{templateId}\",\n \"method\": \"DELETE\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.4200", "message": "Deleted successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.4400", "message": "Bad Request", "isError": true } } } } } } }, "/orgunit/{orgunitId}/groups": { "get": { "tags": [ "Group" ], "summary": "Get Groups", "description": "Retrieves a paginated list of groups associated with a specific orgunit. Supports comprehensive server-side filtering, text searching, and categorical lookups.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 }, "description": "Specifies the page index of the results to retrieve. Must be greater than or equal to 1." }, { "name": "pageSize", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 }, "description": "Controls the maximum number of groups returned per page. Accepts values between 1 and 1000." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Filters the groups by matching alphanumeric characters against the group name or keyword or tags based on searchCategory." }, { "name": "isDialogue", "in": "query", "schema": { "type": "boolean" }, "description": "Filters results based on whether two-way interactive messaging (inbox) is enabled for the group." }, { "name": "searchCategory", "in": "query", "schema": { "type": "string", "default": "Group", "enum": [ "Group", "Keyword", "Tag" ] }, "description": "Narrows down the group search context by a specific predefined category." }, { "name": "groupType", "in": "query", "schema": { "type": "string", "default": "All", "enum": [ "All", "Public", "Info", "Whatsapp" ] }, "description": "Filters the list by the designated group operational mode. Accepted values include Public(Subscription), Info, or Whatsapp." }, { "name": "defaultTag", "in": "query", "schema": { "type": "boolean" } }, { "name": "queryOperator", "in": "query", "schema": { "type": "string", "default": "Any", "enum": [ "Any", "All" ] }, "description": "Specifies the logical evaluation behavior (e.g., AND, OR) applied when combining multiple filtering criteria. Any is used to get result when any of the given matches, All is used to get result when all search is matched." } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups?pageNumber=1&pageSize=10' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups?pageNumber=1&pageSize=10\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups?pageNumber=1&pageSize=10\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponseListPagedResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "post": { "tags": [ "Group" ], "summary": "Add Group", "description": "Provisions a new subscriber segmentation group under the designated orgunit.\nThe endpoint supports three operational group types configured via the request body:\n\n1. SUBSCRIPTION Group: Create by setting both 'info' and 'whatsapp' to false. Used to broadcast SMS/MMS. \n2. INFO Group: Create by setting 'info' to true. Used for info keywords; cannot contain subscribers. \n3. WHATSAPP Group: Create by setting 'whatsapp' to true. Used exclusively for WhatsApp messaging.\n", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupParam" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"string\",\n \"description\": \"string\",\n \"private\": false,\n \"info\": false,\n \"whatsapp\": false,\n \"notificationMobileNos\": [\n \"string\"\n ],\n \"notificationEmails\": [\n \"string\"\n ],\n \"chatEnabled\": true,\n \"autoReponse\": true,\n \"autoResponseMessage\": \"string\",\n \"helpMessage\": \"string\",\n \"stopMessage\": \"string\",\n \"optinMessage\": \"string\"\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"description\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"private\"\": false,\n\" + \"\\n\" +\n@\" \"\"info\"\": false,\n\" + \"\\n\" +\n@\" \"\"whatsapp\"\": false,\n\" + \"\\n\" +\n@\" \"\"notificationMobileNos\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"notificationEmails\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"chatEnabled\"\": true,\n\" + \"\\n\" +\n@\" \"\"autoReponse\"\": true,\n\" + \"\\n\" +\n@\" \"\"autoResponseMessage\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"helpMessage\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"stopMessage\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"optinMessage\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"description\": \"string\",\n \"private\": false,\n \"info\": false,\n \"whatsapp\": false,\n \"notificationMobileNos\": [\n \"string\"\n ],\n \"notificationEmails\": [\n \"string\"\n ],\n \"chatEnabled\": true,\n \"autoReponse\": true,\n \"autoResponseMessage\": \"string\",\n \"helpMessage\": \"string\",\n \"stopMessage\": \"string\",\n \"optinMessage\": \"string\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddGroupResponseExternalApiResponseNew" }, "example": { "data": { "groupId": "4f56e511-f710-4b4e-ac0c-fbf5e55334d8" }, "appCode": "g.2201", "message": "Created Successfuly", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2403", "message": "Forbidden", "isError": true } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}": { "get": { "tags": [ "Group" ], "summary": "Get Group based on Group Id", "description": "Retrieves the complete profile configuration and structural metadata for a specific group. The response includes active tracking keys(groupTrackingCode), automated response rules, and operational flags defining whether it is a SUBSCRIPTION, INFO, or WHATSAPP group.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.1400", "message": "Bad Request", "isError": true } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.1403", "message": "Forbidden", "isError": true } } } } } }, "put": { "tags": [ "Group" ], "summary": "Update existing Group", "description": "Modifies the configuration, features, and default automated responses for an existing group. Use this endpoint to update properties like the group name, description, notification preferences, and compliance messaging layouts.", "parameters": [ { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } }, { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupParam" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request PUT 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"string\",\n \"description\": \"string\",\n \"private\": false,\n \"info\": false,\n \"whatsapp\": false,\n \"notificationMobileNos\": [\n \"string\"\n ],\n \"notificationEmails\": [\n \"string\"\n ],\n \"chatEnabled\": true,\n \"autoReponse\": true,\n \"autoResponseMessage\": \"string\",\n \"helpMessage\": \"string\",\n \"stopMessage\": \"string\",\n \"optinMessage\": \"string\"\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.PUT);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"description\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"private\"\": false,\n\" + \"\\n\" +\n@\" \"\"info\"\": false,\n\" + \"\\n\" +\n@\" \"\"whatsapp\"\": false,\n\" + \"\\n\" +\n@\" \"\"notificationMobileNos\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"notificationEmails\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"chatEnabled\"\": true,\n\" + \"\\n\" +\n@\" \"\"autoReponse\"\": true,\n\" + \"\\n\" +\n@\" \"\"autoResponseMessage\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"helpMessage\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"stopMessage\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"optinMessage\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}\",\n \"method\": \"PUT\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"description\": \"string\",\n \"private\": false,\n \"info\": false,\n \"whatsapp\": false,\n \"notificationMobileNos\": [\n \"string\"\n ],\n \"notificationEmails\": [\n \"string\"\n ],\n \"chatEnabled\": true,\n \"autoReponse\": true,\n \"autoResponseMessage\": \"string\",\n \"helpMessage\": \"string\",\n \"stopMessage\": \"string\",\n \"optinMessage\": \"string\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.3200", "message": "Updated successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3400", "message": "Bad Request", "isError": true } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3403", "message": "Forbidden", "isError": true } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/keywords": { "get": { "tags": [ "Keywords" ], "summary": "Get all Keywords based on GroupId", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "", "schema": { "type": "string", "default": "" } }, { "name": "pageNumber", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 25 } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordsResponsePaginatedResponse4ExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeywordsResponsePaginatedResponse4ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "post": { "tags": [ "Keywords" ], "summary": "Add Keyword", "description": "Add keyword to a group that can be assigned to group and can be used for optin, trigger response when keyword is hit.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "OrgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "GroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Keyword", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordRequestParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeywordRequestParams" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '{\n \"name\": \"string\",\n \"onContact\": \"string\",\n \"notificationEmails\": [\n \"string\"\n ],\n \"notificationMobileNos\": [\n \"string\"\n ]\n}'\n" }, { "lang": "C#", "source": "var options = new RestClientOptions(\"\") {\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Bearer abc\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"onContact\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"notificationEmails\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"notificationMobileNos\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ]\n\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"onContact\": \"string\",\n \"notificationEmails\": [\n \"string\"\n ],\n \"notificationMobileNos\": [\n \"string\"\n ]\n })\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "delete": { "tags": [ "Keywords" ], "summary": "Delete Keywords", "parameters": [ { "name": "orgunitId", "in": "path", "description": "OrgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "GroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delete Keywords", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteKeywords" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteKeywords" } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --g --request DELETE 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '[\n {\n \"name\": \"string\"\n }\n]'\n" }, { "lang": "C#", "source": "var options = new RestClientOptions(\"\") {\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords\", Method.Delete);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Bearer abc\");\nvar body = @\"[\n\" + \"\\n\" +\n@\" {\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" }\n\" + \"\\n\" +\n@\"]\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords\",\n \"method\": \"DELETE\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify([\n {\n \"name\": \"string\"\n }\n ]),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "put": { "tags": [ "Keywords" ], "summary": "Update Keyword", "parameters": [ { "name": "orgunitId", "in": "path", "description": "OrgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "GroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Keywords", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordRequestParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeywordRequestParams" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --g --request PUT 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '{\n \"name\": \"string\",\n \"onContact\": \"string\",\n \"notificationEmails\": [\n \"string\"\n ],\n \"notificationMobileNos\": [\n \"string\"\n ]\n}'\n" }, { "lang": "C#", "source": "var options = new RestClientOptions(\"\") {\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords\", Method.Put);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Authorization\", \"Bearer abc\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"onContact\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"notificationEmails\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"notificationMobileNos\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ]\n\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/keywords\",\n \"method\": \"PUT\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"onContact\": \"string\",\n \"notificationEmails\": [\n \"string\"\n ],\n \"notificationMobileNos\": [\n \"string\"\n ]\n })\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/subscribers": { "get": { "tags": [ "Subscriber" ], "summary": "Get all subscribers of group", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } }, { "name": "startsWith", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/subscribers' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/subscribers\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/subscribers\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriberResponseListPagedResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "post": { "tags": [ "Subscriber" ], "summary": "Add a subscriber to the group", "parameters": [ { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } }, { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberParam" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriberParam" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubscriberParam" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/subscribers' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"mobileNo\": \"string\",\n \"imageUrl\": \"string\",\n \"gender\": \"string\",\n \"address\": {\n \"address1\": \"string\",\n \"address2\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"relations\": [\n {\n \"name\": \"string\",\n \"relationship\": \"string\"\n }\n ],\n \"mobileCountryCode\": \"string\",\n \"age\": 0\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/subscribers\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"firstName\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"lastName\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"mobileNo\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"imageUrl\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"gender\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"address\"\": {\n\" + \"\\n\" +\n@\" \"\"address1\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"address2\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"city\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"state\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"countryCode\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" },\n\" + \"\\n\" +\n@\" \"\"relations\"\": [\n\" + \"\\n\" +\n@\" {\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"relationship\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" }\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"mobileCountryCode\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"age\"\": 0\n\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/subscribers\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"mobileNo\": \"string\",\n \"imageUrl\": \"string\",\n \"gender\": \"string\",\n \"address\": {\n \"address1\": \"string\",\n \"address2\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"relations\": [\n {\n \"name\": \"string\",\n \"relationship\": \"string\"\n }\n ],\n \"mobileCountryCode\": \"string\",\n \"age\": 0\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/subscribers/{mobileNo}": { "delete": { "tags": [ "Subscriber" ], "summary": "Remove a subscriber from the group", "parameters": [ { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } }, { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "mobileNo", "in": "path", "description": "mobileNo", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --g --request DELETE 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/subscribers/{mobileNo}' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var options = new RestClientOptions(\"https://api.poweredbytext.com\") {\n MaxTimeout = -1,\n FollowRedirects = false,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"/orgunit/{orgunitId}/groups/{groupId}/subscribers/{mobileNo}\", Method.Delete);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/subscribers/{mobileNo}\",\n \"method\": \"DELETE\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/messages": { "post": { "tags": [ "Send" ], "summary": "Send SMS, MMS or WhatsApp to subscribers of a group", "description": "Dispatches a one-time message broadcast, test message, unicast message, or \n two-way interactive chat message to subscribers within one or more groups. \n Supports multi-channel delivery including SMS, MMS (requires pre-uploading \n media files to attach a valid 'mediaPath'), and WhatsApp (requires an approved \n WhatsApp template layout).\n \n- 1 SMS = 1 Message Credits\n- 1 MMS = 3 Message Credits\n- 1 WhatsApp = Region based charges from wallet\n", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionBroadcastMessageRequest" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g 'https://api.poweredbytext.com/orgunit/{orgunitId}/messages' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"groupId\": [\n \"string\"\n ],\n \"from\": \"string\",\n \"message\": \"string\",\n \"templateId\": \"string\",\n \"subscriberMobileNo\": [\n \"string\"\n ],\n \"messageType\": \"Test\",\n \"referenceId\": \"string\",\n \"autoSubscribe\": true,\n \"mediaDetails\": {\n \"mediaPath\": [\n {\n \"fileName\": \"string\",\n \"extension\": \"string\",\n \"fileSaveId\": \"string\",\n \"mimetype\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n \"channelType\": \"MMS\",\n \"fallbackMessage\": {\n \"from\": \"GroupName or null\",\n \"message\": \"Failover message to be sent as sms to user\",\n \"channelType\": \"SMS\"\n }\n}'\n" }, { "lang": "C#", "source": "var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.poweredbytext.com/orgunit/{orgunitId}/messages\"); request.Headers.Add(\"Authorization\", \"Bearer Bearer abc\"); var content = new StringContent(\"{\\r\\n \\\"groupId\\\": [\\r\\n \\\"string\\\"\\r\\n ],\\r\\n \\\"from\\\": \\\"string\\\",\\r\\n \\\"message\\\": \\\"string\\\",\\r\\n \\\"templateId\\\": \\\"string\\\",\\r\\n \\\"subscriberMobileNo\\\": [\\r\\n \\\"string\\\"\\r\\n ],\\r\\n \\\"messageType\\\": \\\"Test\\\",\\r\\n \\\"referenceId\\\": \\\"string\\\",\\r\\n \\\"autoSubscribe\\\": true,\\r\\n \\\"mediaDetails\\\": {\\r\\n \\\"mediaPath\\\": [\\r\\n {\\r\\n \\\"fileName\\\": \\\"string\\\",\\r\\n \\\"extension\\\": \\\"string\\\",\\r\\n \\\"fileSaveId\\\": \\\"string\\\",\\r\\n \\\"mimetype\\\": \\\"string\\\",\\r\\n \\\"url\\\": \\\"string\\\"\\r\\n }\\r\\n ]\\r\\n },\\r\\n \\\"channelType\\\": \\\"MMS\\\",\\r\\n \\\"fallbackMessage\\\": {\\r\\n \\\"from\\\": \\\"GroupName or null\\\",\\r\\n \\\"message\\\": \\\"Failover message to be sent as sms to user\\\",\\r\\n \\\"channelType\\\": \\\"SMS\\\"\\r\\n }\\r\\n}\", null, \"application/json\"); request.Content = content; var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/messages\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"groupId\": [\n \"string\"\n ],\n \"from\": \"string\",\n \"message\": \"string\",\n \"templateId\": \"string\",\n \"subscriberMobileNo\": [\n \"string\"\n ],\n \"messageType\": \"Test\",\n \"referenceId\": \"string\",\n \"autoSubscribe\": true,\n \"mediaDetails\": {\n \"mediaPath\": [\n {\n \"fileName\": \"string\",\n \"extension\": \"string\",\n \"fileSaveId\": \"string\",\n \"mimetype\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n \"channelType\": \"MMS\",\n \"fallbackMessage\": {\n \"from\": \"GroupName or null\",\n \"message\": \"Failover message to be sent as sms to user\",\n \"channelType\": \"SMS\"\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/shortUrls": { "post": { "tags": [ "Short URL" ], "summary": "Create a shorten URL", "description": "This function creates a short URL for a long URL, which can help reduce the message character length. To create a new short URL for an existing long URL, set the \"overwrite\" parameter to true. The default value is false, which will return the same previously generated short URL. The function takes a longUrl as input and returns a shortened URL.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShorturlsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShorturlsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ShorturlsRequest" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/shortUrls' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"longUrls\": \"string\",\n \"overwrite\": true\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/shortUrls\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"longUrls\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"overwrite\"\": true\n\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/shortUrls\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"longUrls\": \"string\",\n \"overwrite\": true\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShorturlsResponseExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShorturlsResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/notification-url": { "patch": { "tags": [ "Webhooks" ], "summary": "Update notification setting", "description": "Authentication methods provided for secure communication of webhooks are given below. For each URL, value of authentication type must be passed.\r\n\r\n| Authentication Type | Value | Description |\r\n| ------------ | --- | --------------------------------------------------------------------------------------------------------- | \r\n| No Authentication | none | Webhooks are accessible without any authentication requirements. RequiredParameters: `authenticationType`|\r\n | Basic Authentication | basic | Users must include a username and password with each webhook which is encoded and sent with request. RequiredParameters: `authenticationType`, `userName`, `password`|\r\n| Bearer Token Authentication | oauth | In this method, token generated by the server are included in request headers. RequiredParameters: `authenticationType`, `clientId`, `clientSecret`|", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebHook" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebHook" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebHook" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request PATCH 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/notification-url' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"callbackUrlEnabled\": true,\n \"statusUrlEnabled\": true,\n \"personalUrlEnabled\": true,\n \"callbackUrlSettings\": [\n {\n \"callBackUrl\": \"string\",\n \"authenticationType\": \"string\",\n \"userName\": \"string\",\n \"password\": \"string\",\n \"tokenAuthority\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"clientScope\": \"string\"\n }\n ],\n \"statusUrlSettings\": [\n {\n \"statusUrl\": \"string\",\n \"authenticationType\": \"string\",\n \"userName\": \"string\",\n \"password\": \"string\",\n \"tokenAuthority\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"clientScope\": \"string\"\n }\n ],\n \"personalUrlSettings\": [\n {\n \"personallinkurl\": \"string\",\n \"authenticationType\": \"string\",\n \"userName\": \"string\",\n \"password\": \"string\",\n \"tokenAuthority\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"clientScope\": \"string\"\n }\n ]\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/notification-url\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.PATCH);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"callbackUrlEnabled\"\": true,\n\" + \"\\n\" +\n@\" \"\"statusUrlEnabled\"\": true,\n\" + \"\\n\" +\n@\" \"\"personalUrlEnabled\"\": true,\n\" + \"\\n\" +\n@\" \"\"callbackUrlSettings\"\": [\n\" + \"\\n\" +\n@\" {\n\" + \"\\n\" +\n@\" \"\"callBackUrl\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"authenticationType\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"userName\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"password\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"tokenAuthority\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientId\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientSecret\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientScope\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" }\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"statusUrlSettings\"\": [\n\" + \"\\n\" +\n@\" {\n\" + \"\\n\" +\n@\" \"\"statusUrl\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"authenticationType\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"userName\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"password\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"tokenAuthority\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientId\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientSecret\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientScope\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" }\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"personalUrlSettings\"\": [\n\" + \"\\n\" +\n@\" {\n\" + \"\\n\" +\n@\" \"\"personallinkurl\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"authenticationType\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"userName\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"password\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"tokenAuthority\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientId\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientSecret\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"clientScope\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" }\n\" + \"\\n\" +\n@\" ]\n\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/notification-url\",\n \"method\": \"PATCH\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"callbackUrlEnabled\": true,\n \"statusUrlEnabled\": true,\n \"personalUrlEnabled\": true,\n \"callbackUrlSettings\": [\n {\n \"callBackUrl\": \"string\",\n \"authenticationType\": \"string\",\n \"userName\": \"string\",\n \"password\": \"string\",\n \"tokenAuthority\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"clientScope\": \"string\"\n }\n ],\n \"statusUrlSettings\": [\n {\n \"statusUrl\": \"string\",\n \"authenticationType\": \"string\",\n \"userName\": \"string\",\n \"password\": \"string\",\n \"tokenAuthority\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"clientScope\": \"string\"\n }\n ],\n \"personalUrlSettings\": [\n {\n \"personallinkurl\": \"string\",\n \"authenticationType\": \"string\",\n \"userName\": \"string\",\n \"password\": \"string\",\n \"tokenAuthority\": \"string\",\n \"clientId\": \"string\",\n \"clientSecret\": \"string\",\n \"clientScope\": \"string\"\n }\n ]\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "get": { "tags": [ "Webhooks" ], "summary": "Get notification setting", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/notification-url' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/notification-url\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/notification-url\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebHookExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebHookExternalApiResponseNew" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/contact": { "get": { "tags": [ "Contact" ], "summary": "Get all contacts", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "startsWith", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "mobileCountryCode", "in": "query", "schema": { "type": "string", "default": "US" } }, { "name": "pageNumber", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/contact' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/contact\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/contact\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse1PaginatedResponse3ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/contacts": { "post": { "tags": [ "Contact" ], "summary": "Add Contact", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactParams", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/contacts' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"string\",\n \"age\": 0,\n \"mobileNo\": \"string\",\n \"address\": {\n \"address1\": \"string\",\n \"countryCode\": \"string\",\n \"state\": \"string\",\n \"postalCode\": \"string\"\n },\n \"region\": \"string\",\n \"imageUrl\": \"string\",\n \"email\": \"string\",\n \"customParams\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/contacts\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"firstName\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"lastName\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"gender\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"age\"\": 0,\n\" + \"\\n\" +\n@\" \"\"mobileNo\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"address\"\": {\n\" + \"\\n\" +\n@\" \"\"address1\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"countryCode\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"state\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" },\n\" + \"\\n\" +\n@\" \"\"region\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"imageUrl\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"email\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"customParams\"\": [\n\" + \"\\n\" +\n@\" {\n\" + \"\\n\" +\n@\" \"\"name\"\": \"\"string\"\",\n\" + \"\\n\" +\n@\" \"\"value\"\": \"\"string\"\"\n\" + \"\\n\" +\n@\" }\n\" + \"\\n\" +\n@\" ]\n\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/contacts\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"string\",\n \"age\": 0,\n \"mobileNo\": \"string\",\n \"address\": {\n \"address1\": \"string\",\n \"countryCode\": \"string\",\n \"state\": \"string\",\n \"postalCode\": \"string\"\n },\n \"region\": \"string\",\n \"imageUrl\": \"string\",\n \"email\": \"string\",\n \"customParams\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCreationResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/contacts-image": { "post": { "tags": [ "Contact" ], "summary": "Create Contact Image", "description": "This function allows you to upload a file to set as contact image. The response will include imageUrl that need to be passed in add contact api while creating the contact.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/contacts-image' \\\n--header 'Authorization: Bearer abc...' \\\n--form 'file=@\"/path/to/file\"'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/contacts-image\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AlwaysMultipartFormData = true;\nrequest.AddFile(\"file\", \"/path/to/file\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var form = new FormData();\nform.append(\"file\", fileInput.files[0], \"/path/to/file\");\n\nvar settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/contacts-image\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n \"processData\": false,\n \"mimeType\": \"multipart/form-data\",\n \"contentType\": false,\n \"data\": form\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactImageResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/phonenumbers": { "get": { "tags": [ "Look-up" ], "summary": "Get Phonenumbers", "description": "This API allows you to retrieve relevant information about a designated phone number or multiple phone numbers. It returns metadata that indicates if the phone number is a valid cell phone number and provides information about the carrier associated with the number.\n\nThis API has the capability to verify information for a maximum of 10 phone numbers in a single call.", "parameters": [ { "name": "numbers", "in": "query", "description": "numbers", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "type", "in": "query", "description": "type", "schema": { "type": "string", "default": "carrier" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/phonenumbers' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/phonenumbers\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/phonenumbers\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberResponseListExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/communicationCode": { "get": { "tags": [ "Communication Code" ], "summary": "Get communication code based on GroupId", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/communicationCode' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/communicationCode\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/communicationCode\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringListExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/messages/file": { "post": { "tags": [ "Send" ], "summary": "Upload Media File", "description": "This function allows you to upload a file to be sent as an MMS or WhatsApp to the user.\nThe response will include MediaDetails, which will have an object called\nmediaPath. The mediaPath object contains an array of details about the\nuploaded file such as fileName, extension, fileSaveId, mimetype, and url.\n\nSupported file types: JPG, PNG, GIF, MP4, MP3, PDF\n\n- MMS File size limit(US): 950 KB\n- MMS File size limit(Canada): 750 KB\n- WhatsApp File size limit: 15 MB\n", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "UsedFor", "in": "query", "description": "Required for sending WhatsApp file.", "schema": { "type": "string", "enum": [ "whatsapp" ] } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/messages/file' \\\n--header 'Authorization: Bearer abc...' \\\n--form 'value.file=@\"/path/to/file\"'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/messages/file\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AlwaysMultipartFormData = true;\nrequest.AddFile(\"value.file\", \"/path/to/file\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var form = new FormData();\nform.append(\"value.file\", fileInput.files[0], \"/path/to/file\");\n\nvar settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/messages/file\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n \"processData\": false,\n \"mimeType\": \"multipart/form-data\",\n \"contentType\": false,\n \"data\": form\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaDetailsExternalApiResponseNew" }, "example": { "data": { "mediaPath": [ { "fileName": "welcome_banner", "extension": ".png", "fileSaveId": "fs_987654321", "mimetype": "image/png", "url": "https://example.com/assets/welcome_banner.png" } ] }, "appCode": "g.2201", "message": "Created Successfuly", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/messages/segment/file": { "post": { "tags": [ "Send" ], "summary": "Upload file for segment of subscribers of a group", "description": "This function allows you to upload a CSV file which will have a set of subscribers whom the user wants to send message to. If the subscribers is not subscribed to the particular group, auto subscribe will be done. The response will include fileName, count(subscribers count) and the url of file.\n \nSample File: https://gopbt.me/9e05qH", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/messages/segment/file' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: text/plain' \\\n--form 'subscriberFile.file=@\"/path/to/file\"'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/messages/segment/file\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AlwaysMultipartFormData = true;\nrequest.AddFile(\"subscriberFile.file\", \"/path/to/file\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var form = new FormData();\nform.append(\"subscriberFile.file\", fileInput.files[0], \"/path/to/file\");\n\nvar settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/messages/segment/file\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n \"processData\": false,\n \"mimeType\": \"multipart/form-data\",\n \"contentType\": false,\n \"data\": form\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentFileUploadResponseExternalApiResponseNew" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SegmentFileUploadResponseExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/messages/segment": { "post": { "tags": [ "Send" ], "summary": "Send SMS, MMS or WhatsApp to a Segment", "description": "To send an SMS, MMS or WhatsApp to only few subscribers in a group, you can either\nupload a csv file through Upload file for segment API and attach the file\nurl in segment API or attach an array of ListIds or pass subscriberNumbers in request body schema.\n\n**Audience Resolution Precedence Logic:**\n1. If 'segmentSubscriberFileUrl' is provided, the system processes the CSV file and completely ignores both 'listIds' and 'subscriberNumbers'.\n2. If 'segmentSubscriberFileUrl' is null/omitted and 'listIds' is provided, the system delivers the message to the specified segment lists and ignores 'subscriberNumbers'.\n3. If both 'segmentSubscriberFileUrl' and 'listIds' are null/omitted, the system defaults to sending the message directly to the array of numbers provided in 'subscriberNumbers'.\n\nSupports multi-channel delivery including SMS, MMS (requires pre-uploading media files to attach a valid 'mediaPath'), \nand WhatsApp (requires an approved WhatsApp template layout).\n", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentMessageRequest" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/messages/segment' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"from\": \"string\",\n \"message\": \"string\",\n \"templateId\": \"string\",\n \"type\": \"BroadcastMessage\",\n \"mediaDetails\": {\n \"mediaPath\": [\n {\n \"fileName\": \"string\",\n \"extension\": \"string\",\n \"fileSaveId\": \"string\",\n \"mimetype\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n \"subscriberNumbers\": [\n \"string\"\n ],\n \"segmentSubscriberFileUrl\": \"string\",\n \"channelType\": \"MMS\",\n \"fallbackMessage\": {\n \"from\": \"GroupName or null\",\n \"message\": \"Failover message to be sent as sms to user\",\n \"channelType\": \"SMS\"\n }\n}'\n" }, { "lang": "C#", "source": "var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/messages/segment\"); request.Headers.Add(\"Authorization\", \"Bearer Bearer abc\"); var content = new StringContent(\"{\\r\\n \\\"from\\\": \\\"string\\\",\\r\\n \\\"message\\\": \\\"string\\\",\\r\\n \\\"templateId\\\": \\\"string\\\",\\r\\n \\\"type\\\": \\\"BroadcastMessage\\\",\\r\\n \\\"mediaDetails\\\": {\\r\\n \\\"mediaPath\\\": [\\r\\n {\\r\\n \\\"fileName\\\": \\\"string\\\",\\r\\n \\\"extension\\\": \\\"string\\\",\\r\\n \\\"fileSaveId\\\": \\\"string\\\",\\r\\n \\\"mimetype\\\": \\\"string\\\",\\r\\n \\\"url\\\": \\\"string\\\"\\r\\n }\\r\\n ]\\r\\n },\\r\\n \\\"subscriberNumbers\\\": [\\r\\n \\\"string\\\"\\r\\n ],\\r\\n \\\"segmentSubscriberFileUrl\\\": \\\"string\\\",\\r\\n \\\"channelType\\\": \\\"MMS\\\",\\r\\n \\\"fallbackMessage\\\": {\\r\\n \\\"from\\\": \\\"GroupName or null\\\",\\r\\n \\\"message\\\": \\\"Failover message to be sent as sms to user\\\",\\r\\n \\\"channelType\\\": \\\"SMS\\\"\\r\\n }\\r\\n}\", null, \"application/json\"); request.Content = content; var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/messages/segment\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"from\": \"string\",\n \"message\": \"string\",\n \"templateId\": \"string\",\n \"type\": \"BroadcastMessage\",\n \"mediaDetails\": {\n \"mediaPath\": [\n {\n \"fileName\": \"string\",\n \"extension\": \"string\",\n \"fileSaveId\": \"string\",\n \"mimetype\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n \"subscriberNumbers\": [\n \"string\"\n ],\n \"segmentSubscriberFileUrl\": \"string\",\n \"channelType\": \"MMS\",\n \"fallbackMessage\": {\n \"from\": \"GroupName or null\",\n \"message\": \"Failover message to be sent as sms to user\",\n \"channelType\": \"SMS\"\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentMessageResponseExternalApiResponseNew" }, "example": { "data": { "referenceId": "d675aa4e-6f17-4a8a-9699-b41f50873fa9" }, "appCode": "g.2201", "message": "Created successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/templates": { "post": { "tags": [ "Group" ], "summary": "Add Group Template", "description": "Templates are pre-saved messages that can be sent at any time simply by \npassing a `templateId` to the Message API. There are three types of templates for group:\n- Text Templates: Used to send SMS.\n- Media Templates: Used to send MMS.\n- WhatsApp Templates: Used to send WhatsApp Message.\n\nTo create a Media Template, first call the 'Upload Media File' API in the \nsend section, then pass the 'mediaDetails' object from that response into \nthe template object.\n\nTo create WhatsApp Template refer to the article https://help.poweredbytext.com/s/article/Creating-and-Submitting-WhatsApp-Message-Templates\n", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplateRequestParams" }, "examples": { "SMSTemplate": { "summary": "Text-only Template.", "value": { "name": "Send Welcome Message!", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey" } }, "Mediatemplate": { "summary": "Media Template", "value": { "name": "Welcome Message with Media", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey", "mediaDetails": { "mediaPath": [ { "fileName": "welcome_banner", "extension": ".png", "fileSaveId": "fs_987654321", "mimetype": "image/png", "url": "https://example.com/assets/welcome_banner.png" } ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '{\n \"name\": \"string\",\n \"message\": \"string\"\n}'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Post, \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar content = new StringContent(\"{\\r\\n \\\"name\\\": \\\"string\\\",\\r\\n \\\"message\\\": \\\"string\\\",\\r\\n}\", null, \"application/json\");\nrequest.Content = content;\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify({\n \"name\": \"string\",\n \"message\": \"string\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponseExternalApiResponseNew" }, "example": { "appCode": "g.2201", "message": "Created successfully", "isError": false, "data": { "id": "688452a9-287d-4397-a0fb-9b818eaea897" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } }, "get": { "tags": [ "Group" ], "summary": "Get All Group Templates", "description": "Retrieves a paginated list of group-level message templates. Supports global search filtering by template name or body text, sorting options, and direct lookup using a specific template ID.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search for template details by passing the template name or part of message body.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "sorting", "in": "query", "description": "Retrieve a list of templates sorted by name.", "schema": { "type": "string", "default": "Ascending", "enum": [ "Ascending", "Descending" ] } }, { "name": "templateId", "in": "query", "description": "Get any template details be passing the templateId.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Retrieve a list of templates based on the status of template.", "schema": { "type": "string", "default": "All", "enum": [ "All", "Active", "Pending", "Rejected", "Flagged", "Failed" ] } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates' \\\n--header 'Authorization: Bearer abc'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplatePaginatedResponse3ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } }, "put": { "tags": [ "Group" ], "summary": "Update Group Template", "description": "Modifies the details of an existing group-level message template. This endpoint allows updates to the template name, body text, and the addition/modification of media properties to convert a standard text template into a Media Template (MMS).", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplateEditRequestParams" }, "examples": { "SMSTemplate": { "summary": "Text-only Template.", "value": { "id": "688452a9-287d-4397-a0fb-9b818eaea897", "name": "Send Welcome Message!", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey" } }, "Mediatemplate": { "summary": "Media Template", "value": { "id": "688452a9-287d-4397-a0fb-9b818eaea897", "name": "Welcome Message with Media", "message": "Hey {FirstName}, we are thrilled to have you with us on this journey", "mediaDetails": { "mediaPath": [ { "fileName": "welcome_banner", "extension": ".png", "fileSaveId": "fs_987654321", "mimetype": "image/png", "url": "https://example.com/assets/welcome_banner.png" } ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request PUT 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer abc' \\\n--data '{\n \"id\": \"string\",\n \"name\": \"string\",\n \"message\": \"string\"\n}'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Put, \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar content = new StringContent(\"{\\r\\n \\\"id\\\": \\\"string\\\",\\r\\n \\\"name\\\": \\\"string\\\",\\r\\n \\\"message\\\": \\\"string\\\",\\r\\n}\", null, \"application/json\"); request.Content = content;\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates\",\n \"method\": \"PUT\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"Authorization\": \"Bearer abc\"\n },\n \"data\": JSON.stringify({\n \"id\": \"string\",\n \"name\": \"string\",\n \"message\": \"string\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.3200", "message": "Updated successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3400", "message": "Bad Request", "isError": true } } } } } } }, "/orgunit/{orgunitId}/groups/{groupId}/templates/{templateId}": { "delete": { "tags": [ "Group" ], "summary": "Delete Group Template", "description": "Permanently deletes a specific group-level message template. Once removed, this template will no longer be available to send message.", "parameters": [ { "name": "orgunitId", "in": "path", "description": "orgunitId", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --globoff --request DELETE 'https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates/{templateId}' \\\n--header 'Authorization: Bearer abc'\n" }, { "lang": "C#", "source": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Delete, \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates/{templateId}\");\nrequest.Headers.Add(\"Authorization\", \"Bearer abc\");\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit/{orgunitId}/groups/{groupId}/templates/{templateId}\",\n \"method\": \"DELETE\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.4200", "message": "Deleted successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.4400", "message": "Bad Request", "isError": true } } } } } } }, "/reports/message-reports": { "post": { "tags": [ "Reports" ], "summary": "Get Inbound and Outbound Details", "description": "Generates a paginated report of all inbound and outbound message transmissions within a specified time frame (supports a maximum date range of up to 2 months). Supports granular filtering by targeted group IDs, specific transactional message types (such as Broadcast, TwoWay, OptInResponse, or KeywordResponse), and applies dynamic time zone offsets to accurately align historical delivery metrics.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestParam" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g 'https://api.poweredbytext.com/reports/message-reports' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"groupIds\": [\n \"string\"\n ],\n \"messageTypes\": [\n \"Broadcast\", \"OptInResponse\"\n ],\n \"pageNumber\": 1,\n \"pageSize\": 10,\n \"fromDate\": \"2025-06-12\",\n \"toDate\": \"2025-07-11\",\n \"timeZoneOffset\": \"-6:00\"\n}'\n" }, { "lang": "C#", "source": "var options = new RestClientOptions(\"https://api.poweredbytext.com\") {\n MaxTimeout = -1,\n FollowRedirects = false,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"/reports/message-reports\", Method.Post);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"groupIds\"\": [\n\" + \"\\n\" +\n@\" \"\"string\"\"\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"messageTypes\"\": [\n\" + \"\\n\" +\n@\" \"\"Broadcast\", \"OptInResponse\"\"\n\" + \"\\n\" +\n@\" ],\n\" + \"\\n\" +\n@\" \"\"pageNumber\"\": 1,\n\" + \"\\n\" +\n@\" \"\"pageSize\"\": 10,\n\" + \"\\n\" +\n@\" \"\"fromDate\"\": \"\"2025-06-12\"\",\n\" + \"\\n\" +\n@\" \"\"toDate\"\": \"\"2025-07-11\"\",\n\" + \"\\n\" +\n@\" \"\"timeZoneOffset\"\": \"\"-6:00\"\"\n\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/reports/message-reports\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"groupIds\": [\n \"string\"\n ],\n \"messageTypes\": [\n \"Broadcast\", \"OptInResponse\"\n ],\n \"pageNumber\": 1,\n \"pageSize\": 10,\n \"fromDate\": \"2025-06-12\",\n \"toDate\": \"2025-07-11\",\n \"timeZoneOffset\": \"-6:00\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundOutboundResponsePaginatedResponse3ExternalApiResponseNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" } } } } } } }, "/accounts/segment-lists": { "get": { "tags": [ "Segment List" ], "summary": "Get All Segment Lists", "description": "Retrieves a paginated list of all subscriber segment lists created across the account. Supports global search filtering by list name to quickly locate specific subscriber segments.", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Filters the segment lists by matching alphanumeric characters against the list name." }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 }, "description": "Specifies the page index of the results to retrieve. Must be greater than or equal to 1." }, { "name": "pageSize", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 }, "description": "Controls the maximum number of orgunit returned per page. Accepts values between 1 and 1000." } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/accounts/lists?pageNumber=1&pageSize=10' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/accounts/lists?pageNumber=1&pageSize=10\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/lists?pageNumber=1&pageSize=10\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListsPaginatedResponse3ExternalApiResponseNew" }, "example": { "data": { "pageNumber": 1, "pageSize": 10, "totalCount": 2, "totalPages": 1, "data": [ { "listId": "6942450e69454466111565ff", "listName": "Donors List", "description": "This list is created to thank all new donors for recent campaign", "totalSubscribers": 150, "createdAt": "2026-03-15T09:30:00Z" }, { "listId": "690dddae6c4e5f0410dbfbca", "listName": "VIP Campaign Members", "description": "Targeted segment list for exclusive event invitations", "totalSubscribers": 42, "createdAt": "2026-03-16T14:15:00Z" } ] }, "appCode": "g.1200", "message": "Request successful", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.1400", "message": "Bad Request", "isError": true } } } } } }, "post": { "tags": [ "Segment List" ], "summary": "Create Segment List", "description": "Creates a new subscriber segment list within the account. This list can be initialized as an empty segment container for adding subscribers later, or populated immediately by passing a 'segmentUrl' obtained from the Upload Segment Subscriber File API.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateListFromSegmentFileRequest" }, "example": { "listName": "Donors List", "description": "This list is created to thanks all new donors for recent campaign", "segmentUrl": "https://gopbt.me/files/segmentfileurl" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.poweredbytext.com/orgunit' \\\n--header 'Authorization: Bearer abc...' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"listName\": \"Donors List\",\n \"description\": \"This list is created to thanks all new donors for recent campaign\",\n \"segmentUrl\": \"https://gopbt.me/files/segmentfileurl\"\n}'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/orgunit\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"{\n\" + \"\\n\" +\n@\" \"\"listName\"\": \"\"Donors List\"\",\n\" + \"\\n\" +\n@\" \"\"description\"\": \"\"This list is created to thanks all new donors for recent campaign\"\",\n\" + \"\\n\" +\n@\" \"\"segmentUrl\"\": \"\"https://gopbt.me/files/segmentfileurl\"\"\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/orgunit\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"listName\": \"Donors List\",\n \"description\": \"This list is created to thanks all new donors for recent campaign\",\n \"segmentUrl\": \"https://gopbt.me/files/segmentfileurl\"\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListExternalApiResponseNew" }, "example": { "data": [ "69f85fe47f2e91220d23af6a" ], "appCode": "g.2202", "message": "Request Received", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } } }, "/accounts/segment-lists/file": { "post": { "tags": [ "Segment List" ], "summary": "Upload Segment Subscriber File", "description": "Uploads a CSV file containing subscriber details to the server. Upon successful upload, the endpoint returns a hosted file URL ('fileurl') inside the response payload, which can then be passed to the Create Segment List endpoint to automatically populate a new list.\n \nSample File: https://gopbt.me/9e05qH", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } }, "description": "The CSV file containing subscriber details to be uploaded." } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location -g --request POST 'https://api.poweredbytext.com/accounts/lists/file' \\\n--header 'Authorization: Bearer abc...' \\\n--form 'file=@\"/path/to/file\"'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/accounts/lists/file\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nrequest.AlwaysMultipartFormData = true;\nrequest.AddFile(\"file\", \"/path/to/file\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var form = new FormData();\nform.append(\"value.file\", fileInput.files[0], \"/path/to/file\");\n\nvar settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/lists/file\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n \"processData\": false,\n \"mimeType\": \"multipart/form-data\",\n \"contentType\": false,\n \"data\": form\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSegmentResponseExternalApiResponseNew" }, "example": { "data": { "fileurl": "https://gopbt.me/files/segmentfileurl" }, "appCode": "g.2201", "message": "Created successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.2400", "message": "Bad Request", "isError": true } } } } } } }, "/accounts/segment-lists/{listId}/subscribers": { "get": { "tags": [ "Segment List" ], "summary": "Get Segment List Subscribers", "description": "Retrieves a paginated list of subscribers associated with a specific segment list. The response contains subscriber profiles including contact details, geographic regions, and profile image URLs.", "parameters": [ { "name": "listId", "in": "path", "description": "The unique identifier of the segment list whose subscribers are being retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Filters subscribers within the list by matching alphanumeric characters against their phone number (subscriberNo), first name, or last name.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 }, "description": "Specifies the page index of the results to retrieve. Must be greater than or equal to 1." }, { "name": "pageSize", "in": "query", "required": true, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10 }, "description": "Controls the maximum number of orgunit returned per page. Accepts values between 1 and 1000." } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.poweredbytext.com/accounts/lists/{listId}/subscribers?pageNumber=1&pageSize=10' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var client = new RestClient(\"https://api.poweredbytext.com/accounts/lists/{listId}/subscribers?pageNumber=1&pageSize=10\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.GET);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/lists/{listId}/subscribers?pageNumber=1&pageSize=10\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSubscribersPaginatedResponse3ExternalApiResponseNew" }, "example": { "data": { "pageNumber": 1, "pageSize": 10, "totalCount": 2, "totalPages": 1, "data": [ { "id": "68c7c4cc0d7932730f9124bd", "subscriberNo": "198xxxxx100", "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com", "imageUrl": "https://example.com/avatars/janedoe.jpg", "region": "US", "createdAt": "2026-03-15T09:30:00Z" }, { "id": "68c7c4cc0d7932730f9124be", "subscriberNo": "198xxxxx101", "firstName": "John", "lastName": "Smith", "email": "john.smith@example.com", "imageUrl": "https://example.com/avatars/johnsmith.jpg", "region": "US", "createdAt": "2026-03-15T10:15:00Z" } ] }, "appCode": "g.1200", "message": "Request successful", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.1400", "message": "Bad Request", "isError": true } } } } } }, "put": { "tags": [ "Segment List" ], "summary": "Add Subscribers to Segment List", "description": "Adds multiple new subscribers to an existing segment list in a single batch request. Each entry accepts contact details such as phone number, full name, email, avatar image, and geographic region metadata.", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the target segment list where subscribers will be added." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "An array of subscriber objects to be added to the list in bulk.", "items": { "$ref": "#/components/schemas/AddListSubscriberRequest" }, "example": [ { "subscriberNo": "198xxxxx100", "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com", "imageUrl": "https://example.com/avatars/janedoe.jpg", "region": "US" }, { "subscriberNo": "198xxxxx101", "firstName": "John", "lastName": "Smith", "email": "john.smith@example.com", "imageUrl": "https://example.com/avatars/johnsmith.jpg", "region": "US" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.3200", "message": "Updated successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3400", "message": "Bad Request", "isError": true } } } } } }, "delete": { "tags": [ "Segment List" ], "summary": "Remove Subscribers from Segment List", "description": "Removes one or more subscribers from a specific segment list using their mobile phone numbers. Upon successful removal, the total subscriber count ('TotalSubscribers') for the segment list is automatically decremented.", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the segment list from which subscribers will be removed." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveListSubscriberRequest" } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request DELETE 'https://api.poweredbytext.com/accounts/lists/{listId}/subscribers' \\ --header 'Authorization: Bearer abc...' \\ --header 'Content-Type: application/json' \\ --data-raw '{\n \"subscriberNos\": [\n \"1987xxxxx00\"\n ]\n}'" }, { "lang": "C#", "source": "var options = new RestClientOptions(\"https://api.poweredbytext.com\"); var client = new RestClient(options); var request = new RestRequest(\"/accounts/lists/{listId}/subscribers\", Method.Delete); request.AddHeader(\"Authorization\", \"Bearer abc...\"); request.AddHeader(\"Content-Type\", \"application/json\"); var body = new { subscriberNos = new[] { \"1987xxxxx00\" } }; request.AddJsonBody(body); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content);" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/lists/{listId}/subscribers\",\n \"method\": \"DELETE\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify({\n \"subscriberNos\": [\n \"1987xxxxx00\"\n ]\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.4200", "message": "Deleted successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.4400", "message": "Bad Request", "isError": true } } } } } } }, "/accounts/segment-lists/{listId}/subscribers/{subscriberNo}": { "put": { "tags": [ "Segment List" ], "summary": "Update Subscriber Details in Segment List", "description": "Modifies profile information and contact details for a specific subscriber enrolled within a segment list. Updates apply to fields such as first name, last name, email address, profile avatar image, and geographic region.", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the segment list containing the target subscriber." }, { "name": "subscriberNo", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique mobile phone number identifying the specific subscriber whose details are being updated." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateListSubscriberRequest" }, "example": { "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com", "imageUrl": "https://example.com/avatars/janedoe.jpg", "region": "US" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.3200", "message": "Updated successfully", "isError": false } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.3400", "message": "Bad Request", "isError": true } } } } } } }, "/accounts/segment-lists/{listId}": { "delete": { "tags": [ "Segment List" ], "summary": "Delete Segment List", "description": "Permanently deletes a specific subscriber segment list from the account using its unique identifier. Once deleted, the list container and its associated subscriber associations are permanently removed.", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the segment list to be deleted." } ], "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --g --request DELETE 'https://api.poweredbytext.com/accounts/lists/{listId}' \\\n--header 'Authorization: Bearer abc...'\n" }, { "lang": "C#", "source": "var options = new RestClientOptions(\"https://api.poweredbytext.com\") {\n MaxTimeout = -1,\n FollowRedirects = false,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"/accounts/lists/{listId}\", Method.Delete);\nrequest.AddHeader(\"Authorization\", \"Bearer abc...\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);\n" }, { "lang": "JavaScript", "source": "var settings = {\n \"url\": \"https://api.poweredbytext.com/accounts/lists/{listId}\",\n \"method\": \"DELETE\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Bearer abc...\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});\n" } ], "responses": { "200": { "description": "List deleted successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiResponseNew" }, "example": { "appCode": "g.4200", "message": "Deleted successfully", "isError": false } } } }, "400": { "description": "Bad request or invalid list ID provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalErrorResponse" }, "example": { "appCode": "g.4400", "message": "Bad Request", "isError": false } } } } } } } }, "x-webhooks": { "InboundMessageWebhook": { "post": { "summary": "Inbound Message Webhook", "tags": [ "Webhooks" ], "description": "The Inbound Messages webhook is triggered by receipt of a message to your PBT account. It sends a JSON payload to your specified URL. The JSON payload contains the following information given below in response schema about the inbound message.\r\n\r\nEvery message received sends the data shown in sample to the target URL. The `CustomParams` parameters may be specified and will be implemented by PBT.\r\n\r\nThe target URL is set up by the Account owner and given to PBT. PBT then sets the target URL as the destination for the webhook data. The recepient may use the received data however they see fit.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundMessageWebhookResponse" } } } } } } }, "MessageStatusWebhook": { "post": { "summary": "Message Status Webhook", "tags": [ "Webhooks" ], "description": "The Message Status webhook is triggered as a message sent from an Account progresses to a Subscriber. It sends a JSON payload to a URL specified the account owner.\r\n\r\nThe JSON payload contains the information about the message given in smaple.\r\n\r\nThe target URL is set up by the account owner and given to PBT. PBT then sets the target URL as the destination for the webhook data. This received data may be used however the account wishes.\r\n\r\nWhen the message moves through a stage, the data shown in sample is sent to the target URL.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageStatusWebhookResponse" } } } } } } }, "ShortUrlWebhook": { "post": { "summary": "Short URL Event Webhook", "tags": [ "Webhooks" ], "description": "The Short Url Webhook enables real-time data synchronization by triggering notifications for two key lifecycle events: `URL generation` and `user engagement`.\r\n\r\nWhen a unique personal URL is successfully created, the system pushes the link metadata directly to your configured endpoint. Additionally, a second payload is dispatched the moment a user accesses the link, providing immediate visibility into click activity. This dual-event functionality allows you to automate downstream workflows and track conversion metrics seamlessly.\r\n\r\nThe `CustomParams` parameters may be specified and will be implemented by PBT", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortUrlWebhookResponse" } } } } } } } }, "components": { "schemas": { "RegisterUser": { "required": [ "email", "password", "phone" ], "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phone": { "type": "string", "format": "tel" }, "email": { "type": "string", "format": "email" }, "password": { "maxLength": 15, "minLength": 8, "pattern": "^(?=.*\\d)(?=.*[a-z])(?=.*[A-Z])(?=.*[^a-zA-Z0-9])(?!.*\\s).*$", "type": "string", "format": "password" }, "imageURL": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "Address": { "type": "object", "properties": { "address1": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegisterCompany": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "irsNo": { "type": "string", "nullable": true }, "taxExemption": { "type": "boolean" }, "shortName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "phone": { "type": "string", "nullable": true }, "webAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegisterAccount": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "planId": { "type": "string", "nullable": true }, "registerUser": { "$ref": "#/components/schemas/RegisterUser" }, "registerCompany": { "$ref": "#/components/schemas/RegisterCompany" }, "countryCode": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "accountStatus": { "type": "string", "nullable": true }, "autoResponseMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegisterAccountExternalApiResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RegisterAccount" }, "appCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "T": { "type": "object", "additionalProperties": false }, "ExternalApiResponse`1": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/T" }, "appCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MediaPath": { "type": "object", "properties": { "fileName": { "type": "string" }, "extension": { "type": "string" }, "fileSaveId": { "type": "string" }, "mimetype": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "MediaDetails": { "type": "object", "properties": { "mediaPath": { "type": "array", "items": { "$ref": "#/components/schemas/MediaPath" }, "nullable": true } }, "additionalProperties": false }, "AppTemplate": { "type": "object", "properties": { "templateId": { "type": "string" }, "name": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" }, "mediaDetails": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/MediaDetails" } ] } }, "additionalProperties": false }, "AppTemplatePaginatedResponse3": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int64", "readOnly": true }, "pageSize": { "type": "integer", "format": "int64", "readOnly": true }, "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" }, "readOnly": true } }, "additionalProperties": false }, "AppTemplatePaginatedResponse3ExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppTemplatePaginatedResponse3" }, "appCode": { "type": "string" }, "message": { "type": "string" }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ExternalErrorResponse": { "type": "object", "properties": { "appCode": { "type": "string" }, "message": { "type": "string" }, "isError": { "type": "boolean", "default": true } }, "additionalProperties": false }, "AppTemplateEditRequestParams": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the account template to be updated." }, "name": { "type": "string", "description": "The current or updated name of the template." }, "message": { "type": "string", "description": "The updated text content for the template message body." }, "mediaDetails": { "description": "The media attachment details. Include this object to update or convert the template into a Media Template (MMS).", "allOf": [ { "$ref": "#/components/schemas/MediaDetails" } ] } }, "additionalProperties": false }, "ExternalApiResponseNew": { "type": "object", "properties": { "appCode": { "type": "string" }, "message": { "type": "string" }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "AppTemplateRequestParams": { "type": "object", "required": [ "name", "message" ], "properties": { "name": { "type": "string", "description": "Template name can be alphanumeric characters along with special characters." }, "message": { "type": "string", "description": "This message will be sent to the subscriber when this template is used." }, "mediaDetails": { "description": "Add mediaDetails to template to create a Media Template.", "allOf": [ { "$ref": "#/components/schemas/MediaDetails" } ] } }, "additionalProperties": false }, "TemplateResponse": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false }, "TemplateResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TemplateResponse" }, "appCode": { "type": "string" }, "message": { "type": "string" }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "CommCode": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CommunicationCodes": { "type": "object", "properties": { "commCode": { "type": "array", "items": { "$ref": "#/components/schemas/CommCode" }, "nullable": true } }, "additionalProperties": false }, "OrgunitResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "accountId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "shortName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "contactNo": { "type": "string", "nullable": true }, "imageURL": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "details": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "groups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultCampus": { "type": "boolean" }, "shortenEnabled": { "type": "boolean" }, "shortenUrlLength": { "type": "integer", "format": "int32" }, "communicationCodes": { "$ref": "#/components/schemas/CommunicationCodes" }, "autoResponseMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrgunitResponseListPaginatedResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "filterCount": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrgunitResponse" }, "nullable": true } }, "additionalProperties": false }, "OrgunitResponseListPaginatedResponseExternalApiResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrgunitResponseListPaginatedResponse" }, "appCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ObjectExternalApiResponse": { "type": "object", "properties": { "data": { "nullable": true }, "appCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrgunitParam": { "required": [ "email", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The official descriptive name of the new orgunit or brand." }, "email": { "type": "string", "format": "email", "description": "The primary administrative email address associated with the brand." }, "contactNo": { "type": "string", "description": "A primary contact phone number for the orgunit." }, "imageURL": { "type": "string", "nullable": true, "description": "A direct URL hosting the brand's logo or profile avatar." }, "details": { "type": "string", "nullable": true, "description": "Additional context or miscellaneous profile notes regarding the brand." }, "address": { "description": "The physical location details for the orgunit.", "allOf": [ { "$ref": "#/components/schemas/Address" } ] } }, "additionalProperties": false }, "CampusIdResponse": { "type": "object", "properties": { "campusId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CampusIdResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CampusIdResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "Keywords": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "onContact": { "type": "string", "nullable": true }, "notificationEmails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notificationMobileNos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "orgunitId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Campuses": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "Themes": { "enum": [ "Light", "Dark" ], "type": "string" }, "Preferences": { "type": "object", "properties": { "helpEnabled": { "type": "boolean", "default": true }, "themes": { "$ref": "#/components/schemas/Themes" } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "accountId": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "shortName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "imageURL": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "active": { "type": "boolean" }, "hidden": { "type": "boolean" }, "addedBy": { "type": "string", "nullable": true }, "addedOn": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "nullable": true }, "modifiedOn": { "type": "string", "format": "date-time", "nullable": true }, "campuses": { "$ref": "#/components/schemas/Campuses" }, "preferences": { "$ref": "#/components/schemas/Preferences" } }, "additionalProperties": false }, "GroupResponse": { "type": "object", "properties": { "id": { "type": "string" }, "orgunitId": { "type": "string" }, "accountId": { "type": "string" }, "name": { "type": "string" }, "keywords": { "type": "array", "items": { "$ref": "#/components/schemas/Keywords" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "nullable": true }, "private": { "type": "boolean" }, "info": { "type": "boolean" }, "whatsapp": { "type": "boolean" }, "notificationMobileNos": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notificationEmails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "chatEnabled": { "type": "boolean" }, "autoReponse": { "type": "boolean" }, "autoResponseMessage": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "groupTrackingCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupResponseListPagedResponse": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GroupResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GroupResponseListPagedResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GroupResponseListPagedResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "GroupParam": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The official descriptive name of the group. Must be unique within the organization unit." }, "description": { "type": "string", "nullable": true, "description": "An optional text summary providing additional context or organizational details about the group's purpose." }, "info": { "type": "boolean", "default": false, "description": "Set to true to establish this as an INFO group used exclusively for information-only keywords. When true, the group cannot maintain subscribers." }, "whatsapp": { "type": "boolean", "default": false, "description": "Set to true to establish this as a WHATSAPP group used exclusively for WhatsApp related subscribers." }, "notificationMobileNos": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "An array of mobile phone numbers that will receive notifications regarding inbound messages." }, "notificationEmails": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "An array of administrative email addresses that will receive notifications regarding inbound messages." }, "chatEnabled": { "type": "boolean", "description": "Enables or disables two-way interactive chat messaging (inbox) for subscribers within this group." }, "autoReponse": { "type": "boolean", "description": "When set to true, enables automated system responses to be sent back to subscribers based inbound messages." }, "autoResponseMessage": { "type": "string", "nullable": true, "description": "The text payload delivered to a subscriber as a standard automated fallback response when 'autoReponse' is enabled." }, "helpMessage": { "type": "string", "nullable": true, "description": "The custom compliance message sent to non-subscribers who text the 'HELP' keyword to your communication code." }, "stopMessage": { "type": "string", "nullable": true, "description": "The custom compliance confirmation text sent to non-subscribers who opt out by replying with the 'STOP' keyword." }, "optinMessage": { "type": "string", "nullable": true, "description": "The custom welcome/compliance message delivered to a subscriber immediately after successfully opting into this group." } }, "additionalProperties": false }, "AddGroupResponse": { "type": "object", "properties": { "groupId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddGroupResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AddGroupResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "GroupResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GroupResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "KeywordsResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "onContact": { "type": "string", "nullable": true }, "notificationEmails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notificationMobileNos": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "KeywordsResponsePaginatedResponse4": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "filterCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/KeywordsResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "KeywordsResponsePaginatedResponse4ExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/KeywordsResponsePaginatedResponse4" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "KeywordRequestParams": { "type": "object", "properties": { "name": { "type": "string", "nullable": false }, "onContact": { "type": "string", "nullable": false, "description": "Keyword response message to be added in this field" }, "notificationEmails": { "type": "array", "items": { "type": "string" }, "nullable": false }, "notificationMobileNos": { "type": "array", "items": { "type": "string" }, "nullable": false } }, "additionalProperties": false }, "DeleteKeywords": { "type": "object", "properties": { "name": { "type": "string", "nullable": false } }, "additionalProperties": false }, "Relation": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "relationship": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Properties": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetSubscriberResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "middleName": { "type": "string", "nullable": true }, "mobileNo": { "type": "string", "nullable": true }, "landLineNo": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "age": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/Relation" }, "nullable": true }, "mobileCountryCode": { "type": "string", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Properties" }, "nullable": true } }, "additionalProperties": false }, "GetSubscriberResponseListPagedResponse": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetSubscriberResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GetSubscriberResponseListPagedResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetSubscriberResponseListPagedResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "SubscriberParam": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "mobileNo": { "type": "string", "required": true }, "imageUrl": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/Relation" }, "nullable": true }, "mobileCountryCode": { "type": "string", "nullable": true }, "age": { "type": "integer", "format": "int32", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Properties" }, "nullable": true } }, "additionalProperties": false }, "SubscriberResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubscriberResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriberResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "FallbackMessage": { "type": "object", "properties": { "from": { "type": "string", "nullable": true }, "message": { "type": "string" }, "channelType": { "type": "string" } }, "additionalProperties": false }, "InteractionBroadcastMessageRequest": { "required": [ "groupId", "message", "messageType" ], "type": "object", "properties": { "groupId": { "type": "array", "items": { "type": "string" }, "description": "An array of unique groupIds targeting the subscriber lists that will receive this message." }, "from": { "type": "string", "description": "The sending entity identifier or group name displayed to the recipient in the message's start." }, "message": { "type": "string", "description": "The raw text payload to be delivered to subscribers. Leave empty or omit if you are utilizing a pre-configured template layout via 'templateId'." }, "templateId": { "type": "string", "description": "The unique identifier of a message template. When passed, the system will deliver the structured template message layout. For sending WHATSAPP broadcast, this field is mandatory." }, "subscriberMobileNo": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "An array of specific destination mobile phone numbers. Used to isolate delivery to individual subscribers instead of the entire group list. Mandatory for messageType Test, Twoway and Unicast" }, "messageType": { "type": "string", "enum": [ "Test", "BroadcastMessage", "Twoway", "Unicast" ], "description": "Defines the operational intent of the transmission. Valid values are: 'Test' (internal verification), 'BroadcastMessage' (mass campaign), 'Twoway' (one-to-one interactive chat), or 'Unicast' (targeted multi-number delivery)." }, "referenceId": { "type": "string", "nullable": true, "description": "An optional external tracking or transaction identifier used to correlate this transmission with your internal database records." }, "autoSubscribe": { "type": "boolean", "default": false, "description": "When set to true, automatically opts in and subscribes any phone numbers provided in 'subscriberMobileNo' to the targeted group if they are not already members." }, "mediaDetails": { "nullable": true, "description": "The media attachment properties. Include this object with a valid 'mediaPath' array (retrieved from the Upload Media File endpoint) to execute an MMS or rich media broadcast.", "allOf": [ { "$ref": "#/components/schemas/MediaDetails" } ] }, "channelType": { "type": "string", "enum": [ "SMS", "MMS", "WHATSAPP" ], "description": "Specifies the target communication network channel for delivery. Accepted values include SMS, MMS, or WHATSAPP." }, "fallbackMessage": { "nullable": true, "description": "An alternate message configuration payload. Serves as a downstream delivery fallback if the primary 'channelType' fails or is unsupported by the recipient's handset. Primarily used in case of MMS failover to SMS.", "allOf": [ { "$ref": "#/components/schemas/FallbackMessage" } ] } }, "additionalProperties": false }, "MessageResponse": { "type": "object", "properties": { "transactionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MessageResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MessageResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ShorturlsRequest": { "type": "object", "properties": { "longUrl": { "type": "string", "nullable": false }, "overwrite": { "type": "boolean" } }, "additionalProperties": false }, "CreateShorturlsResponse": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateShorturlsResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateShorturlsResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "CallbackUrlSettings": { "type": "object", "properties": { "callBackUrl": { "type": "string", "nullable": true }, "authenticationType": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "tokenAuthority": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "clientScope": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StatusUrlSettings": { "type": "object", "properties": { "statusUrl": { "type": "string", "nullable": true }, "authenticationType": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "tokenAuthority": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "clientScope": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PersonalLinkSettings": { "type": "object", "properties": { "personallinkurl": { "type": "string", "nullable": true }, "authenticationType": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "tokenAuthority": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "clientScope": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WebHook": { "type": "object", "properties": { "callbackUrlEnabled": { "type": "boolean" }, "statusUrlEnabled": { "type": "boolean" }, "personalUrlEnabled": { "type": "boolean" }, "callbackUrlSettings": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackUrlSettings" }, "nullable": true }, "statusUrlSettings": { "type": "array", "items": { "$ref": "#/components/schemas/StatusUrlSettings" }, "nullable": true }, "personalUrlSettings": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalLinkSettings" }, "nullable": true } }, "additionalProperties": false }, "WebHookExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebHook" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "AddressResponse": { "type": "object", "properties": { "address1": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RelationsResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "relationship": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubscriptionGroup": { "type": "object", "properties": { "groupId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomParams": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "ContactResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "mobileNo": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "address": { "$ref": "#/components/schemas/AddressResponse" }, "gender": { "type": "string", "nullable": true }, "age": { "type": "integer", "format": "int32", "nullable": true }, "orgunitId": { "type": "string", "nullable": true }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/RelationsResponse" }, "nullable": true }, "region": { "type": "string", "nullable": true }, "subscriptionGroup": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionGroup" }, "nullable": true }, "birthDate": { "type": "string", "format": "date-time" }, "imageUrl": { "type": "string", "nullable": true }, "customParams": { "type": "array", "items": { "$ref": "#/components/schemas/CustomParams" }, "nullable": true } }, "additionalProperties": false }, "ContactResponsePaginatedResponse": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int64", "readOnly": true }, "pageSize": { "type": "integer", "format": "int64", "readOnly": true }, "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ContactResponse1PaginatedResponse3ExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactResponsePaginatedResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "Contact": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "age": { "type": "integer", "format": "int32" }, "mobileNo": { "type": "string" }, "address": { "$ref": "#/components/schemas/Address" }, "region": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "customParams": { "type": "array", "items": { "$ref": "#/components/schemas/Properties" }, "nullable": true } }, "additionalProperties": false }, "ContactCreationResponse": { "type": "object", "properties": { "contactId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactCreationResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactCreationResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ContactImageResponse": { "type": "object", "properties": { "imageUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactImageResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactImageResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "PhoneNumberResponse": { "type": "object", "properties": { "number": { "type": "string", "nullable": true }, "carrierCode": { "type": "string", "nullable": true }, "carrierName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PhoneNumberResponseListExternalApiResponseNew": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberResponse" }, "nullable": true }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "StringListExternalApiResponseNew": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "MediaDetailsExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaDetails" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "SegmentFileUploadResponse": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SegmentFileUploadResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SegmentFileUploadResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "SegmentTypes": { "enum": [ "BroadcastMessage" ], "type": "string" }, "SegmentMessageRequest": { "required": [ "message" ], "type": "object", "properties": { "from": { "type": "string", "description": "The sending entity identifier or group name displayed to the recipient in the message's start." }, "message": { "type": "string", "description": "The raw text payload to be delivered to subscribers. Leave empty or omit if you are utilizing a pre-configured template layout via 'templateId'." }, "templateId": { "type": "string", "description": "The unique identifier of a message template. When passed, the system will deliver the structured template message layout. For sending WHATSAPP broadcast, this field is mandatory.", "nullable": true }, "type": { "$ref": "#/components/schemas/SegmentTypes" }, "mediaDetails": { "nullable": true, "description": "The media attachment properties. Include this object with a valid 'mediaPath' array (retrieved from the Upload Media File endpoint) to execute an MMS or rich media broadcast.", "allOf": [ { "$ref": "#/components/schemas/MediaDetails" } ] }, "referenceId": { "type": "string", "nullable": true, "description": "An optional external tracking or transaction identifier used to correlate this transmission with your internal database records." }, "subscriberNumbers": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "An array of specific destination mobile phone numbers. Used to isolate delivery to individual subscribers instead of the entire group list." }, "segmentSubscriberFileUrl": { "type": "string", "nullable": true, "description": "Url of csv file containing specific destination mobile phone numbers. Used to isolate delivery to individual subscribers instead of the entire group list." }, "listIds": { "type": "array", "nullable": true, "description": "An array of list objects targeting specific segment lists for audience delivery.", "items": { "type": "object", "required": [ "ListId" ], "properties": { "ListId": { "type": "string", "description": "The unique identifier of the target segment list." } } } }, "channelType": { "type": "string", "enum": [ "SMS", "MMS", "WHATSAPP" ], "description": "Specifies the target communication network channel for delivery. Accepted values include SMS, MMS, or WHATSAPP." }, "fallbackMessage": { "nullable": true, "description": "An alternate message configuration payload. Serves as a downstream delivery fallback if the primary 'channelType' fails or is unsupported by the recipient's handset. Primarily used in case of MMS failover to SMS.", "allOf": [ { "$ref": "#/components/schemas/FallbackMessage" } ] } }, "additionalProperties": false }, "SegmentMessageResponse": { "type": "object", "properties": { "referenceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SegmentMessageResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SegmentMessageResponse" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "WhatsappButton": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "description": "Values such as URL, QUICK_REPLY, PHONE_NUMBER" }, "postbackData": { "type": "string", "nullable": true }, "text": { "type": "string", "description": "Button text required for all types." }, "phoneNumber": { "type": "string", "nullable": true, "description": "Required for type PHONE_NUMBER" }, "url": { "type": "string", "nullable": true, "description": "Required for type URL" }, "example": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlaceHolderData": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TemplateBody": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "placeHolders": { "type": "array", "items": { "$ref": "#/components/schemas/PlaceHolderData" }, "description": "To be used for merge fields such as FirstName, LastName", "nullable": true } }, "additionalProperties": false }, "TemplateFooter": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TemplateHeader": { "type": "object", "properties": { "format": { "type": "string", "nullable": true, "description": "Values such as TEXT, IMAGE, VIDEO, DOCUMENT" }, "url": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WhatsappTemplatesRequestParams": { "required": [ "name", "language" ], "type": "object", "properties": { "name": { "type": "string" }, "referenceId": { "type": "string", "nullable": true }, "language": { "type": "string" }, "category": { "type": "string", "description": "MARKETING, UTILITY and AUTHENTICATION" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/WhatsappButton" }, "nullable": true }, "body": { "$ref": "#/components/schemas/TemplateBody" }, "footer": { "$ref": "#/components/schemas/TemplateFooter" }, "header": { "$ref": "#/components/schemas/TemplateHeader" } }, "additionalProperties": false }, "Template": { "type": "object", "properties": { "templateId": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "nullable": true }, "parentOrgunitId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "whatsappTemplate": { "$ref": "#/components/schemas/WhatsappTemplatesRequestParams" } }, "additionalProperties": false }, "TemplatePaginatedResponse3": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int64", "readOnly": true }, "pageSize": { "type": "integer", "format": "int64", "readOnly": true }, "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Template" }, "readOnly": true } }, "additionalProperties": false }, "TemplatePaginatedResponse3ExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TemplatePaginatedResponse3" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ReportRequestParam": { "type": "object", "properties": { "groupIds": { "type": "array", "items": { "type": "string" }, "description": "An array of unique groupIds used to narrow down the message report metrics to specific subscriber groups." }, "messageTypes": { "type": "array", "items": { "type": "string", "enum": [ "SystemMessage", "ScheduledBroadcast", "StopResponse", "HelpResponse", "OptInResponse", "BroadcastTest", "StopAllResponse", "KeywordResponse", "Deact", "Notification", "Unicast", "AutoResponse", "Broadcast", "TwoWay", "Twoway", "Keyword", "ReservedKeyword" ] }, "description": "An array of transactional message type categories to include in the report." }, "pageNumber": { "type": "integer", "format": "int32", "description": "Specifies the page index of the filtered reporting results to retrieve. Must be greater than or equal to 1." }, "pageSize": { "type": "integer", "format": "int32", "description": "Controls the maximum number of log records returned per page response." }, "fromDate": { "type": "string", "description": "The starting point of the reporting window formatted as a standard date string (YYYY-MM-DD). The total window spanned between 'fromDate' and 'toDate' must not exceed a maximum duration of 2 months." }, "toDate": { "type": "string", "description": "The concluding endpoint of the reporting window formatted as a standard date string (YYYY-MM-DD). The total window spanned between 'fromDate' and 'toDate' must not exceed a maximum duration of 2 months." }, "timeZoneOffset": { "type": "string", "description": "The target numeric or string timezone displacement value used to accurately align historical UTC logs with your local business timeline metrics." } }, "additionalProperties": false }, "PropertiesNew": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InboundOutboundResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier generated for the specific message transaction log." }, "accountId": { "type": "string", "description": "The unique identifier of the top-level PBT account." }, "divisionId": { "type": "string", "description": "The unique identifier of the brand division or campus associated with the message." }, "groupId": { "type": "string", "description": "The unique identifier of the group that sent or received the message transmission." }, "messageType": { "type": "string", "description": "The specific category of the message transaction (e.g., Broadcast, TwoWay, AutoResponse, KeywordResponse)." }, "message": { "type": "string", "description": "The actual raw text content delivered to or received from the subscriber." }, "subscriberNo": { "type": "string", "description": "The mobile phone number of the subscriber involved in the transmission." }, "groupName": { "type": "string", "description": "The descriptive name of the messaging group at the time of transmission." }, "communicationCode": { "type": "string", "description": "The short code or 10DLC phone number used to send or receive the message." }, "direction": { "type": "string", "description": "Indicates the routing flow of the traffic. Typically 'Inbound' or 'Outbound'." }, "statusCode": { "type": "string", "nullable": true, "description": "The platform or network aggregator status code string representing delivery state." }, "statusCodeDescription": { "type": "string", "nullable": true, "description": "A human-readable description of the delivery status code (e.g., Delivered, Message Queued)." }, "transactionTicket": { "type": "string", "nullable": true, "description": "A downstream carrier-level transaction ticket code used for network tracing." }, "timestamp": { "type": "string", "format": "date-time", "description": "The localized timestamp indicating exactly when the message event occurred." }, "referenceId": { "type": "string", "nullable": null, "description": "The client-provided tracking identifier passed during the initial send request." }, "subscriberFirstName": { "type": "string", "nullable": true, "description": "The first name of the contact, if registered in the subscriber profile." }, "subscriberLastName": { "type": "string", "nullable": true, "description": "The last name of the contact, if registered in the subscriber profile." }, "mediaUrl": { "type": "string", "nullable": true, "description": "The hosted public file link for attachments if the transmission was a media-based message (MMS/WhatsApp)." }, "customParams": { "type": "array", "items": { "$ref": "#/components/schemas/PropertiesNew" }, "nullable": true, "description": "Optional key-value metadata parameters attached to the transaction for custom business workflows." }, "isFallback": { "type": "boolean", "description": "Indicates whether this transmission was automatically converted to an SMS failover due to an MMS delivery failure." }, "region": { "type": "string", "nullable": true, "description": "The subscriber geographic territory or country code context assigned to the transmission." }, "utilizedAmount": { "type": "string", "nullable": true, "description": "The credit total deducted from the account wallet balance for Whatsapp message delivery." } }, "additionalProperties": false }, "InboundOutboundResponsePaginatedResponse3": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int64", "readOnly": true }, "pageSize": { "type": "integer", "format": "int64", "readOnly": true }, "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/InboundOutboundResponse" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "InboundOutboundResponsePaginatedResponse3ExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/InboundOutboundResponsePaginatedResponse3" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "Lists": { "type": "object", "properties": { "listId": { "type": "string" }, "name": { "type": "string" }, "totalSubscribers": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "processedFileUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ListsPaginatedResponse3": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int64", "readOnly": true }, "pageSize": { "type": "integer", "format": "int64", "readOnly": true }, "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Lists" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ListsPaginatedResponse3ExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ListsPaginatedResponse3" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "CreateListFromSegmentFileRequest": { "required": [ "listName" ], "type": "object", "properties": { "listName": { "type": "string", "description": "The unique descriptive name used to identify the segment list." }, "description": { "type": "string", "description": "An optional summary providing organizational context or details about the segment list audience.", "nullable": true }, "segmentUrl": { "type": "string", "description": "An optional file URL obtained from the Segment File Upload API to automatically populate the list with subscribers upon creation. If omitted, an empty segment list is created.", "nullable": true } }, "additionalProperties": false }, "AddSegment": { "type": "object", "properties": { "fileurl": { "type": "string" } }, "additionalProperties": false }, "AddSegmentResponseExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AddSegment" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ListSubscribers": { "type": "object", "properties": { "id": { "type": "string", "description": "The subscriber's unique identifier.", "nullable": true }, "firstName": { "type": "string", "description": "The subscriber's first name.", "nullable": true }, "lastName": { "type": "string", "description": "The subscriber's last name.", "nullable": true }, "subscriberNo": { "type": "string", "description": "The mobile phone number of the subscriber." }, "region": { "type": "string", "description": "The geographic territory or region assigned to the subscriber profile." }, "email": { "type": "string", "description": "The subscriber's email address.", "nullable": true }, "imageUrl": { "type": "string", "description": "A direct URL hosting the subscriber's avatar or profile picture.", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ListSubscribersPaginatedResponse3": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int64", "readOnly": true }, "pageSize": { "type": "integer", "format": "int64", "readOnly": true }, "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListSubscribers" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ListSubscribersPaginatedResponse3ExternalApiResponseNew": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ListSubscribersPaginatedResponse3" }, "appCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "default": false } }, "additionalProperties": false }, "AddListSubscriberRequest": { "required": [ "subscriberNo" ], "type": "object", "properties": { "subscriberNo": { "type": "string", "description": "The mobile phone number of the subscriber." }, "firstName": { "type": "string", "nullable": true, "description": "The subscriber's first name." }, "lastName": { "type": "string", "nullable": true, "description": "The subscriber's last name." }, "email": { "type": "string", "nullable": true, "description": "The subscriber's first name." }, "imageUrl": { "type": "string", "nullable": true, "description": "A direct URL hosting the subscriber's avatar or profile picture." }, "region": { "type": "string", "description": "The geographic territory or region assigned to the subscriber profile." } }, "additionalProperties": false }, "RemoveListSubscriberRequest": { "required": [ "subscriberNos" ], "type": "object", "properties": { "subscriberNos": { "type": "array", "items": { "type": "string" }, "description": "An array of mobile phone numbers (subscriberNos) to be removed from the segment list." } }, "additionalProperties": false }, "UpdateListSubscriberRequest": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true, "description": "The subscriber's updated first name." }, "lastName": { "type": "string", "nullable": true, "description": "The subscriber's updated last name." }, "email": { "type": "string", "nullable": true, "description": "The updated primary email address associated with the subscriber." }, "imageUrl": { "type": "string", "nullable": true, "description": "A direct URL hosting the subscriber's updated avatar or profile image." }, "region": { "type": "string", "description": "The updated geographic territory or region code assigned to the subscriber profile." } }, "additionalProperties": false }, "CustomParamsNew": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InboundMessageWebhookResponse": { "type": "object", "properties": { "ExternalReferenceId": { "type": "string", "description": "AccountId" }, "Message": { "type": "string", "description": "Message from user." }, "SubscriberNo": { "type": "string", "description": "User mobile number." }, "GroupName": { "type": "string", "description": "Group name" }, "GroupId": { "type": "string", "description": "GroupId" }, "DivisionId": { "type": "string", "description": "DivisionId" }, "CommunicationCode": { "type": "string", "description": "Code to which message was received." }, "MessageType": { "type": "string", "description": "Values: TwoWay, TwoWayMms, Keyword, ReservedKeyword, DeviceDelivery." }, "ReceivedTime": { "type": "string", "format": "date-time", "description": "DateTime value is string format." }, "CustomParams": { "type": "array", "items": { "$ref": "#/components/schemas/CustomParamsNew" }, "nullable": true } }, "additionalProperties": false }, "MessageStatusWebhookResponse": { "type": "object", "properties": { "ExternalReferenceId": { "type": "string", "description": "AccountId" }, "Message": { "type": "string", "description": "Message sent to subscriber." }, "GroupName": { "type": "string", "description": "Group name." }, "GroupId": { "type": "string", "description": "GroupId" }, "DivisionId": { "type": "string", "description": "DivisionId" }, "CommunicationCode": { "type": "string", "description": "Code from which message was sent." }, "DeliveredTime": { "type": "string", "format": "date-time", "description": "Delivery time in string format." }, "CustomParams": { "type": "array", "items": { "$ref": "#/components/schemas/CustomParamsNew" }, "nullable": true }, "StatusCode": { "type": "string", "description": "Statuscode for the message sent." }, "StatusCodeDescription": { "type": "string", "description": "Status description for message sent." }, "TransactionTicket": { "type": "string", "description": "TrasactionId" }, "ReferenceId": { "type": "string", "description": "ReferenceId" }, "SubscriberNo": { "type": "string", "description": "Subscriber number to which message was sent." }, "MessageType": { "type": "string", "description": "Values: Twoway, OptInResponse, KeywordResponse, AutoResponse, Broadcast, BroadcastTest, StopResponse, HelpResponse, StopAllResponse, BroadcastDeviceDelivery, Notification, Unicast, Dialog, SystemMessage" }, "TotalMessageSegments": { "type": "integer", "format": "int32", "description": "Message parts sent to subscriber." } } }, "ShortUrlWebhookResponse": { "type": "object", "properties": { "AccountId": { "type": "string", "description": "AccountId" }, "EventType": { "type": "string", "description": "Values: Created, Hit." }, "ShortUrl": { "type": "string", "description": "Smarturl created for subscriber." }, "LongUrl": { "type": "string", "description": "Long url provided for shortening." }, "PersonalizedUrl": { "type": "boolean", "description": "Indicated whether it is personalized or not." }, "GroupName": { "type": "string", "description": "Group name," }, "GroupId": { "type": "string", "description": "GroupId" }, "DivisionId": { "type": "string", "description": "DivisionId" }, "CreatedTime": { "type": "string", "format": "date-time", "description": "DateTime value is string format." }, "SubscriberNo": { "type": "string", "description": "Subscriber number." }, "FirstName": { "type": "string", "description": "Subscriber firstname." }, "LastName": { "type": "string", "description": "Subscriber lastname." }, "CustomParams": { "type": "array", "items": { "$ref": "#/components/schemas/CustomParamsNew" }, "nullable": true } }, "additionalProperties": false } } }, "x-tagGroups": [ { "name": "Organization", "tags": [ "Account", "Orgunit", "Group", "Keywords" ] }, { "name": "People", "tags": [ "Contact", "Subscriber" ] }, { "name": "Messages", "tags": [ "Send", "Segment List", "Webhooks", "Reports", "Look-up", "Communication Code" ] }, { "name": "Extras", "tags": [ "Short URL" ] } ] }