{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"be876c6d-95c2-4a23-b591-a1d4d83c8347","name":"Public Simasti.com API","description":"The Simasti API enables you to manage your client account programmatically.\n\nIt provides endpoints to manage your balance, send individual messages and campaigns, and view reports.\n\nThe REST API operates over the secure HTTPS protocol, providing a range of methods to make requests and return responses for each operation.\n\nAll responses are in JSON structures, with all references to API requests in the documentation including the mandatory base URL: `https://my.simasti.com`\n\n- if specified \"required\"- this parameter is mandatory in the API call and must always be set with an appropriate value\n    \n- If specified \"Optional\" you can ommit this parameter altogether from the API call, in this case, default values will be set implicitly.\n    \n\n# Authentication\n\nBefore making use of the APIs, you will need:\n\n- A JWT token received on `/login` call. This token is transmitted in the headers of any request, except when the token itself is received - then it is not required.\n    \n    - the token will be provided after calling the **Authentication** / **login** api call, using the login/password you were provided with\n        \n- Example for required headers for authentication:\n    \n\n`curl -X 'POST' '`[<code>https://my.simasti.com/api/v1/message-send'</code>](https://mogo.io/api/v1/message-send')`-H 'accept: application/json' -H 'Authorization: Bearer _`**`MwMzQzODA\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*4MzAzNzk4MH0.s`**`_SFtikTgjACDwGvr0DQ'`\n\nwhere the Authorization: Bearer is the received token.\n\nThe default life time of the token is **2 hours,** this can be adapted to your system's needs. please request that from [support@simasti.com](https://mailto:support@simasti.com)\n\n# Error codes\n\n| **Error code** | **Identifier** | **Description** |\n| --- | --- | --- |\n| 0 | SUCCESS | Successful request. |\n| 1 | E_UNKNOWN | Unknown error occured. |\n| 2 | E_INTERNAL | Simasti internal error occured. |\n| 3 | E_OVERLOAD | Too much requests. |\n| 4 | E_AUTHENTICATION | Common authentication error. It could be bad login/password/token/access denied or disable account. |\n| 5 | E_BAD_LOGIN | Wrong or absent account. |\n| 6 | E_BAD_PASSWORD | Wrong password. |\n| 7 | E_BAD_CREDENTIALS | Wrong login/password or absent account. |\n| 8 | E_TOKEN_INVALID | Bad access token. |\n| 9 | E_TOKEN_EXPIRED | Access token is expired. |\n| 10 | E_BAD_SMS_CODE | Bad SMS verification code entered. |\n| 11 | E_USER_NOT_FOUND | User not found. |\n| 12 | E_USER_ALREADY_EXIST | User already exists. |\n| 13 | E_USER_INACTIVE | User disabled by administrator. |\n| 14 | E_USER_AGENCY_INACTIVE | Agency disabled by administrator. |\n| 15 | E_MODULE_ACCESS_DENIED | Request not allowed for this user. |\n| 16 | E_BAD_PARAMETER | Bad parameter or value in request. |\n| 17 | E_ITEM_NOT_FOUND | Object not found. |\n| 18 | E_ITEM_WITH_ID_NOT_FOUND | Object with such ID not found. |\n| 19 | E_ITEM_ALREADY_EXIST | Object with such parameters already exists. |\n| 20 | E_PASSWORD_EQUAL_LOGIN | Password should not match with login. |\n| 21 | E_AGENCY_NOT_FOUND | Agency not found. |\n| 22 | E_USER_ACCESS_DENIED | Access denied for user. |\n| 23 | E_AGENCY_ACCESS_DENIED | Access denied for user from agency. |\n| 24 | E_ACCOUNT_ACCESS_DENIED | Access denied fro account. |\n| 25 | E_CLIENT_ACCESS_DENIED | Access denied for client. |\n| 26 | E_NETWORK | Unknown network error. |\n| 27 | E_NETWORK_REQUEST | Network error occured while request. |\n| 28 | E_NETWORK_RESPONSE | Network error occured while response. |\n| 29 | E_NETWORK_CONNECTION | Network connection error. |\n| 31 | E_NETWORK_CONFIGURATION | Network configuration error. |\n| 33 | E_CLIENT_NOT_FOUND | Client not found. |\n| 34 | E_ACCOUNT_NOT_FOUND | Account not found. |\n| 35 | E_ACCOUNT_CREDENTIALS_SAVE | Can't save account credentials. |\n| 36 | E_ACCOUNT_CREDENTIALS_READ | Can't read account credentials. |\n| 37 | E_ACCOUNT_CREDENTIALS_UPDATE | Can't change account credentials. |\n| 38 | E_ACCOUNT_CREDENTIALS_DELETE | Can't delete account credentials. |\n| 39 | E_ACCOUNT_CREDENTIALS_NOT_FOUND | Can't find account credentials. |\n| 40 | E_PROVIDER | Unknown message provider error. |\n| 41 | E_PROVIDER_BAD_REQUEST | Bad request to message provider. |\n| 42 | E_PROVIDER_UNAUTHORIZED | User is not authorized on message provider side. |\n| 43 | E_PROVIDER_FORBIDDEN | Access forbidden on message provider side. |\n| 44 | E_PROVIDER_NOT_FOUND | Message provider not found. |\n| 45 | E_PROVIDER_METHOD_NOT_ALLOWED | Message provider method not allowed. |\n| 46 | E_PROVIDER_TIMEOUT | Request timeout on message provider. |\n| 47 | E_PROVIDER_OVERLOAD | too much request for message provider. |\n| 48 | E_PROVIDER_INTERNAL | Message provider internal error. |\n| 49 | E_PROVIDER_BAD_GATEWAY | Message provider bad gateway. |\n| 50 | E_PROVIDER_SERVICE_UNAVAILABLE | Message provider is not available. |\n| 51 | E_PROVIDER_GATEWAY_TIMEOUT | Message provider gateway timeout. |\n| 52 | E_PROVIDER_BAD_PARAMETER | Bad parameter or value at message provider request. |\n| 53 | E_PROVIDER_BAD_CREDENTIALS | Message provider bad login, password or token. |\n| 54 | E_PROVIDER_BAD_RESPONSE | Message provider bad response. |\n| 55 | E_PROVIDER_LOW_BALANCE | Message provider low balance. |\n| 56 | E_PROVIDER_BAD_TARGET_NUMBER | Message provider bad target number. |\n| 57 | E_PROVIDER_BAD_SOURCE_NUMBER | Message provider bad source number. |\n| 58 | E_PROVIDER_MESSAGE_TOO_LONG | Message too long for message provider. |\n| 59 | E_PROVIDER_MESSAGE_EXPIRED | Message expired. |\n| 60 | E_PROVIDER_MESSAGE_NOT_DELIVERED | Message not delivered. |\n| 61 | E_PROVIDER_MESSAGE_UNDELIVERABLE | Message is undeliverable. |\n| 62 | E_PROVIDER_FATAL | Message provider fatal error. |\n| 63 | E_PROVIDER_SYSTEM | Message provider system error |\n| 64 | E_PROVIDER_DISABLED | Message provider is disabled or suspended. |\n| 65 | E_PROVIDER_ADAPTER_DISABLED | Message provider adapter is disabled. |\n| 70 | E_BAD_TARGET_NUMBER | Bad target number. |\n| 71 | E_BAD_SOURCE_NUMBER | Bad source number. |\n| 72 | E_LOW_BALANCE | Low balance for client or agency. |\n| 73 | E_NOT_DELIVERED | Message not delivered. |\n| 74 | E_INVALID_NUMBERS | Bad one more target numbers from list. |\n| 76 | E_MESSAGE_TOO_LONG | Message too long. |\n| 77 | E_SEND_TIME_ERROR | Send time bad parameter value. |\n| 78 | E_INSUFFICIENT_CREDIT_MESSAGE_PENGIND | Insufficient balance for pending messages. |\n| 80 | E_PRICING_MODEL_NOT_FOUND | Pricing model not found for this account. |\n| 81 | E_PRICING_RULE_NOT_FOUND | Pricing rule not found for this account. |\n| 82 | E_PRICING_RULE_BAD_CONFIGURATION | Bad configuration for pricing rules. |\n| 83 | E_INSUFFICIENT_CLIENT_CREDIT | Low client balance. |\n| 84 | E_INSUFFICIENT_AGENCY_CREDIT | Low agency balance. |\n| 85 | E_BAD_PHONE_NUMBER | Bad phone number format. |\n| 86 | E_BAD_PHONE_COUNTRY | Phone number country is not supported. |\n| 87 | E_TRY_TO_ACCESS_NOT_ALLOWED_ITEM | Access denied for request. |\n| 88 | E_INVALID_ROLE | Bad user role. |\n| 89 | E_KPI_NOT_EXIST | Key Performance Indicators (KPI) value does not exist. |\n| 90 | E_STOP_WORD_NOT_FOUND | Stop word not found. |\n| 91 | E_STOP_WORD_REACHED_MAXIMUM | Stop word count reached maximum. |\n| 92 | E_DISALLOW_TO_SEND_SMS | SMS sending is forbidden for account. |\n| 93 | E_CONTACT_BOOK_METADATA_COUNT | Reached maximum metadata count for client contact book. |\n| 94 | E_CONTACT_BOOK_NOT_ALLOWED_METADATA_FIELD | Not allowed metadata field for contact book. |\n| 95 | I_NO_CAMPAIGN_TO_HANDLE | No campaign to handle. |\n| 96 | I_NO_MESSAGE_TO_HANDLE | No message to handle for campaign. |\n| 97 | E_CAMPAIGN_NOT_FOUND_TO_START | Campaign not found to start. |\n| 98 | E_CAMPAIGN_ALREADY_STARTED | Campaign already started. |\n| 99 | E_CAMPAIGN_COUNTRIES_NOT_FOUND | Campaign countries not found. |\n| 100 | E_ROUTING_RULE_NOT_FOUND | Routing rule not found. Please contact the support. |\n| 101 | E_TOO_MANY_MAPPINGS | Too many mappings for campaign. |\n| 102 | E_MAPPING_EXISTS | Mapping already exists for campaign. |\n| 103 | E_ADAPTER_ALREADY_IN_THIS_STATUS | Message provider adapter already in this status. |\n| 104 | E_ADAPTER_CANT_BE_ACTIVATED | Message provider adapter can't be activated. |\n| 105 | E_MMS_CONTENT_NOT_PROVIDED |  |\n| 106 | E_DISALLOW_TO_SEND_MMS |  |\n| 107 | E_FILE_SIZE_LIMIT_REACHED |  |\n| 108 | E_BAD_FILE_UPLOAD |  |\n| 109 | E_PHONE_NO_ANSWER |  |\n| 110 | E_NONE_MESSAGE_TYPE_SETTINGS |  |\n| 111 | E_DISALLOW_TO_SEND_VOICE_MESSAGE |  |\n| 112 | E_UNKNOWN_MESSAGE_TYPE |  |\n| 113 | E_VOICE_MESSAGE_TO_KOSHER_NUMBER_DISABLED |  |\n| 114 | E_FROM_SHOULD_BE_NUMBER_FOR_KOSHER_NUMBERS |  |\n| 115 | E_VERIFY_TOKEN_IS_INVALID |  |\n| 116 | E_TO_SHOULD_NOT_BE_EMPTY |  |\n| 117 | E_BAD_CONTENT_LINK |  |\n| 118 | E_NOTIFICATION_MISSING_CONTACTS |  |\n| 119 | E_NOTIFICATION_TOO_MANY_CONTACTS |  |\n| 120 | E_AGENCY_INTERNAL |  |\n| 121 | E_AGENCY_NOT_INTERNAL |  |\n| 122 | E_ACCOUNT_DISABLED |  |\n| 123 | E_PROVIDER_MESSAGE_UNDELIVERABLE_NO_DEVICE_RESPONSE |  |\n| 124 | E_PHONE_CALL_BARRED |  |\n| 125 | E_PHONE_NO_MMS_SUPPORT |  |\n| 126 | E_MMS_FILE_ERROR |  |\n| 127 | E_DISALLOW_TO_SEND_MAIL_TO_SMS |  |\n| 128 | E_DISALLOW_TO_SEND_PREMIUM_MESSAGE |  |\n| 129 | E_DUPLICATE_MESSAGE |  |\n| 130 | E_EMAIL_ACCOUNT_ALREADY_VERIFIED |  |\n| 131 | E_DUPLICATE_MESSAGE_THROTTLER |  |\n| 132 | E_DISALLOW_TO_SEND_FLASH_SMS |  |\n| 133 | E_REPORT_NOT_FOUND |  |\n| 134 | E_REPORT_DATE_INVALID |  |\n| 135 | E_SMPP_LOGIN_TOO_LONG |  |\n| 136 | E_NUMBER_BLOCKED_DNC |  |\n| 137 | E_MESSAGE_BLOCKED_DO_NOT_SEND_WINDOW |  |\n| 138 | E_DISCOUNT_NON_APPLIABLE |  |\n| 139 | E_CREDIT_POOL_NOT_FOUND |  |\n| 140 | E_SMPP_SESSION_DISCONNECTED |  |\n| 141 | E_ACCOUNT_LOGIN_ALREADY_USED |  |\n| 142 | E_FORBIDDEN_MESSAGE_CONTENT |  |\n| 143 | E_DISALLOW_TO_SEND_OTP |  |\n| 144 | E_VERIFICATION_NUMBER_BLOCKED |  |\n| 145 | E_VERIFICATION_EXPIRED_OR_NOT_CREATED |  |\n| 146 | E_VERIFICATION_SERVICE_UNAVAILABLE |  |\n| 147 | E_SMPP_CONNECTION_POOL_EMPTY |  |\n| 148 | E_CAMPAING_NOT_FOUND |  |\n| 149 | E_CAMPAIGN_NOT_CANCELLED |  |\n| 150 | E_CAMPAIGN_CANCELLED_LIST_NOT_READY |  |\n| 151 | E_CAMPAIGN_CANCELLD_LIST_UNAVAILABLE |  |\n| 152 | E_AGENCY_HAS_CLIENTS |  |\n| 153 | E_CAMPAIGN_CANCELLED |  |\n| 154 | E_PASSWORD_RESET_LINK_INVALID |  |\n| 155 | E_CAPTCHA_REQUIRED |  |\n| 156 | E_CAMPAIGN_TEMPLATE_LIMIT_REACHED |  |\n| 157 | E_CAPTCHA_VERIFICATION_FAILED |  |\n| 158 | E_EMAIL_ALREADY_USED |  |\n| 159 | E_ACCOUNT_DISABLED_TOO_MANY_WRONG_CODES |  |\n\n## When should you retry sending a failed message?\n\nNote that Simasti has its internal retry mechanism, which also switch's between the available Cellular opeator for the specific message. So it is highly **not encouraged** to retry sending a message, in any case the submit to Simasti returned 2XX\n\nWhen to retry ? only on the following HTTP responses : **500, 429,502,503**\n\n# Operational or OTP messages\n\nSimasti offers an optimised message processing for sending time critical messages such as 2fa codes etc. In order to utilise this capability, please include the parameter **isOTP=true** in your **message_send** call. This way your time critical messages will \"bypass\" the marketing messages and will be sent promptly.\n\n# Delivery reports & Inbound SMS & Webhooks\n\n**DLR**\n\n- note: if you need to whitelist our ip, please whitelist the following IP address: **34.159.168.8**\n    \n\nWebhooks are automated messages sent from applications when certain events occur. In the case of a delivery report webhook, this event is the delivery status of a message.\n\nWhen configured to use webhooks, the application will send a ,messsage to the webhook (specified web address), with details of the delivery report, such as the status, delivery timestamp and other associated data.\n\nThe structure of DLR is as follows:\n\n``` json\n{\n  \"messageId\": \"6405c60994590434f55a3cty\",\n  \"customSendId\": \"exampleSendId\",\n  \"to\": \"+972552603210\",\n  \"status\": \"delivered\",\n  \"messageQnt\": 1,\n  \"submitDate\": \"2023-03-06T10:52:57.656Z\",\n  \"error\": 0,\n  \"errorDescription\": \"Successful request.\"\n}\n\n ```\n\nThe webhook response contains information about the submission of a message to a given phone number. It includes the message id, the phone number the message was sent to, the status of the message (whether it was delivered or not), the number of messages sent, the date and time when the message was submitted, the date and time when the message was delivered, and an error code (with 0 indicating no errors). Also, if customSendId parameter was passed when sending a message, it will also be received in DLR.\n\n# Incoming / Inbound SMS\n\n- note: if you need to whitelist our ip, please whitelist the following IP address: **34.159.168.8**\n    \n\nIncoing or Inbound sms, is an sms that is sent from your customers to a virtual number you've purchased for your business, from Simasti ( ask [support@simasti.com](https://mailto:support@simasti.com) ). These can be messages such as unsubscribe replies ( Stop, etc ), event confirmation or any other business case you might come with.\n\nOnce Simasti recieves an incoming SMS, it first identifies the Virtual number that it was sent to, in order to know know that it belongs to your brand. and then a POST call to the webhook will be executed.\n\nYou can define a webhook per each of the virtual numbers that are configured for your account.\n\neach Incoming message- will be forwarded to the respective webhook that is define for that specific virtual number.\n\nIf for a specific virtual number, no webhook is defined, the Inbound messages are sent to the same webhook that is set for the DLR.\n\nThe incoming POST call will have this structure:\n\n``` json\n{\n    \"target\": \"0529999555\",\n    \"source\": \"0529999555\",\n    \"text_utf8\": \"webhook test\"\n}\n\n ```\n\nTarget : the virtual number\n\nsource : the recipients number\n\ntext_utf8: the body of the message that was received\n\n# Mail2Voice\n\nMail to voice is a method of sending TextToVoice via Email. its done by sending an email to a defined email of Simasti. The email is then processed, a respective Text To Voice is triggered.\n\nTo send sms Text To Voice using Email, you must first register your email addresses in the Simasti system (please contact Simasti's support) . Once registered, you can send Text To Voice by following a specific email format, which is outlined below.\n\n**Note**, the identity is determined by the sender's email address, so its critical to register the correct email addres from which Simasti will receive the email-2-sms requests.\n\nTo activate the necessary settings for each client, our Backoffice system must be accessed. (contact your admin for details) The email format required is as follows:\n\n- The email is sent to the Simasti mailbox\n    \n- The mailbox to send to is [<b>mail2voice@simasti.com</b>](https://mailto:mail2sms@simasti.com)\n    \n- Use the following subject format: \"`From: [Sender's name] To: [comma-separated target numbers in international format`, for example: `From:Sendername To:+972552603210,+972552603211`\n    \n- Include the message text in the body of the email. Sent email should be plain text, not HTML.\n    \n- Example usage: `From:Sendername To:+972552603210,+972552603211`\n    \n\n# Short Tracked Links\n\nSimasti offers you the possibility to send URLs which in most cases are going to be significatnly shorter then your original URL, and would be tracked by simasti.\n\nPlease refer to the **Short Links** api call\n\nTo use this : please generate the links using POST short-links. GET short-links\n\n# Mail2Sms\n\nMail to SMS is a method of sending SMS via Email. its done by sending an email to a defined email of Simasti. The email is then processed, a respective SMS is generated and sent with the content that is specified in the email.\n\nTo send sms messages using Email, clients must first register their email addresses in the Simasti system (please contact Simasti's support) . Once registered, clients can send messages by following a specific email format, which is outlined below.\n\n**Note**, the identity is determined by the sender's email address, so its critical to register the correct email addres from which Simasti will receive the email-2-sms requests.\n\nTo activate the necessary settings for each client, our Backoffice system must be accessed. (contact your admin for details) The email format required is as follows:\n\n- The email is sent to the Simasti mailbox\n    \n- The mailbox to send to is [<b>mail2sms@simasti.com</b>](https://mailto:mail2sms@simasti.com)\n    \n- Use the following subject format: \"`From: [Sender's name] To: [comma-separated target numbers in international format`, for example: `From:Sendername To:+972552603210,+972552603211`\n    \n- Include the message text in the body of the email. Sent email should be plain text, not HTML.\n    \n- In the Mail2SMS subject, you have the option to include a non-mandatory parameter, \"delay:\", to control the delay for sending the SMS via the API call.By specifying this parameter, you can customize the delay period before the SMS is sent. The default value is set to 0 if no value is provided.Example usage: `From:Sendername To:+972552603210,+972552603211 delay:60`This will set the delay parameter to 60 seconds for the SMS to be sent.\n    \n- Please note that only regular SMS can be sent via Mail2sms.\n    \n\n# Personalising your SMS\n\nThe sms body can be personlised with content that you upload with your contact list. In order to do that you need to:\n\n1. Create meta data fields - [using this endpoint](https://api.simasti.com/#26c92245-355a-412e-83e2-9d4c1321c299)\n    \n2. Upload the data - [using this endpoint](https://api.simasti.com/#59446d23-40fe-4bb8-8ef9-03c259a551ee)\n    \n3. Use the tags in the message body - [using this endpoint](https://api.simasti.com/#5edaf99b-98f3-45ed-b552-6dbdec6463bb) (when sending campaign messages)\n    \n\nFor example, after importing metadata with following fields:\n\n`curl --location '`[<code>https://my.simasti.com/api/v1/contact-list/import/mapping'</code>](https://mogo.io/api/v1/contact-list/import/mapping')\n\n`--header 'Content-Type: application/json' --header 'Authorization: {{vault:bearer-token}}?iH****\\\\\\\\\\*LZZmH6yn' --data '{\"contactListName\": \"ContactList1\", \"fileName\": \"ContactListCsv.csv\", \"delimeter\": \";\", \"phone\":{ \"index\": 0 }, \"metadata\":[ {\"name\":{\"index\": 1}}, {\"description\":{\"index\": 2 }} ] }'`\n\nA request with metadata fields for sending campaign message can be used:\n\n`curl --location '`[<code>https://my.simasti.com/api/v1/campaign/send'</code>](https://mogo.io/api/v1/campaign/send')\n\n`--header 'Content-Type: application/json' --header 'Authorization: {{vault:bearer-token}}?**' --data '{ \"name\": \"CampaignName\", \"messageTemplate\": \"Hello [#name#]! We have a special offer for you: [#description#]\", \"source\": \"SenderName\", \"type\": \"sms\", \"contactListIds\": [ \"648825d51d2301a40bf6fb76\" ] }'`\n\n# Codes Pool, Sending Coupons to your customers.\n\nYou can Automatically send codes to your customers.\n\n- The codes can either be generated by you, or will be generated by us and handed over to you.\n    \n- you can select how many codes are going to be sent\n    \n- Once all codes are consumed / sent to customers, any further SMS's, in the case there are more SMS's then codes, SMS's will fail and a respective DLR will be sent.\n    \n- The codes are grouped under a \"tag\"\n    \n    - you can have multiple tags / code pulls for different purposes.\n        \n\n**important: There is no interface to upload the codes, right now its done in the backend.**\n\nIn order to run a coupon campaign, you will need to:\n\n1\\. in your SMS's body, place the following place holder: **\\[#code#\\]**\n\n2\\. make sure the codes are uploaded ( please contact us for that ).\n\n3\\. select a tag under which these codes are going to be uploaded.\n\n4\\. send your API calls with the following parameter :\n\n```\napplyDiscountCode=<TagName>\n\n ```\n\n# Sending Verification Codes\n\n- note, this function has a pre-requiisite : A virtual number.\n    \n\nIf you need the functionality of sending a Verification Code, and verify the reply. There is a simple pair of methods that saves you the mechanism of generating, maintaing the life time etc of the code.\n\nPlease refere to OTP Verification\n\nThe process would be as follows:  \n1\\. **send-otp**\n\nto send a verification code to a recipient. The system will generate and send a code with a standard message to the recipient. you do not need to generate the code .\n\nThe recipient is then replying with the code that was sent to him/her.  \n2\\. **verify-otp** , to see if the code that the recipient has sent is the correct code, and if its within the defined time.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24456169","team":4307386,"collectionId":"be876c6d-95c2-4a23-b591-a1d4d83c8347","publishedId":"2sB3HjM1Nx","public":true,"publicUrl":"https://api.simasti.com","privateUrl":"https://go.postman.co/documentation/24456169-be876c6d-95c2-4a23-b591-a1d4d83c8347","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-09-02T19:55:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e7a549de61876daa0f268d669eb6e66ae7394c507cb7a42c4a3bc7abebf924be","favicon":"https://simasti.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.simasti.com/view/metadata/2sB3HjM1Nx"}