{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/mobilesimportal.com" } ], "info": { "name": "MobileSimPortal API v1", "_postman_id": "da7e0361-b346-41e3-8b05-9467656afdc2", "description": "Stable v1 API reference for MobileSimPortal accounts, one-time mobile rentals, long-term mobile rentals, mobile proxies, and one-time number rates.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json", "version": "1.0.0" }, "item": [ { "name": "Authentication", "description": "Create and revoke bearer tokens for the current account.", "item": [ { "name": "Create an API token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/create-token", "query": [], "raw": "{{baseUrl}}\/api\/create-token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"login\":\"micxflzmhtjl\",\"password\":\"&A~#l9?\\\/1xjX\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"success\":true,\"token\":\"\"}", "name": "New 24-hour bearer token." }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Bad request.\"}", "name": "Request is not eligible in its current state." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"Authentication failed.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Revoke the current API token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/invalidate-token", "query": [], "raw": "{{baseUrl}}\/api\/invalidate-token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"The current token has been invalidated.\"}", "name": "Successful response." }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Bad request.\"}", "name": "Request is not eligible in its current state." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] } ] }, { "name": "Account", "description": "Read account information and current reference data used by rental requests.", "item": [ { "name": "Get account profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/profile-info", "query": [], "raw": "{{baseUrl}}\/api\/profile-info" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"balance\":25.5,\"swap credits\":1.5,\"personal data\":{\"email\":\"customer@example.com\",\"skype\":null,\"telephone\":null,\"signup\":\"13 Oct 2026 12:00\"}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "List one-time rental services", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/services", "query": [], "raw": "{{baseUrl}}\/api\/services" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"service\":\"Unknown\",\"price\":0.5,\"available\":1}]}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "List supported U.S. states", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/states", "query": [], "raw": "{{baseUrl}}\/api\/states" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[\"AL\",\"NY\"]}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] } ] }, { "name": "One-Time Mobile Rentals", "description": "Request one-time mobile numbers, check status and messages, and manage eligible reuse, rejection, and reply actions.", "item": [ { "name": "List one-time rental history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/one-time-rent\/one-time-rent-pins", "query": [], "raw": "{{baseUrl}}\/api\/one-time-rent\/one-time-rent-pins" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":1,\"service\":\"Unknown\",\"mdn\":12345678901,\"offset\":1,\"limit\":1}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"request\":11111111,\"time\":\"10\\\/13\\\/2026 12:00 PM\",\"service\":\"Unknown\",\"mdn\":\"16095550123\",\"sms_pin\":\"123456\",\"sms_content\":\"Synthetic example message.\",\"status\":\"Success\",\"billed\":0.5}]}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Request a one-time mobile number", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/one-time-rent\/request", "query": [], "raw": "{{baseUrl}}\/api\/one-time-rent\/request" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"service\":\"Unknown\",\"state\":\"AL\",\"markup\":\"10\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"success\":true,\"mdn\":\"+1 (609) 555-0123\",\"request\":11111111}", "name": "Number assigned." }, { "header": [], "code": 201, "body": "{\"success\":true,\"status\":\"Awaiting MDN\",\"request\":11111111}", "name": "Accepted; poll priority-request-mdn for number assignment." }, { "header": [], "code": 400, "body": "{\"service\":[\"The selected service is invalid.\"]}", "name": "Legacy validation returns a direct field-to-messages map." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 402, "body": "{\"success\":false,\"message\":\"Please add balance to your account to use this service.\"}", "name": "Insufficient available credit." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." }, { "header": [], "code": 503, "body": "{\"success\":false,\"message\":\"Service is unavailable.\"}", "name": "Service unavailable; a mutation may still have an unresolved outcome. Do not retry blindly." } ] }, { "name": "Get a priority request number", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/one-time-rent\/priority-request-mdn", "query": [], "raw": "{{baseUrl}}\/api\/one-time-rent\/priority-request-mdn" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"request\":11111111}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Awaiting MDN\"}", "name": "Number assignment pending." }, { "header": [], "code": 200, "body": "{\"success\":true,\"mdn\":\"+1 (609) 555-0123\"}", "name": "Number assigned." }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Bad request.\"}", "name": "Request is not eligible in its current state." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Get request status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/one-time-rent\/status", "query": [], "raw": "{{baseUrl}}\/api\/one-time-rent\/status" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"request\":11111111}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[]}", "name": "Status payload in data; legacy opaque payload, not a fixed resource schema." }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Bad request.\"}", "name": "Request is not eligible in its current state." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." }, { "header": [], "code": 500, "body": "{\"success\":false,\"message\":\"Server error.\"}", "name": "Request failed; mutation outcomes may be unresolved." }, { "header": [], "code": 503, "body": "{\"success\":false,\"message\":\"Service is unavailable.\"}", "name": "Service unavailable; a mutation may still have an unresolved outcome. Do not retry blindly." } ] }, { "name": "Read a request message", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/one-time-rent\/message", "query": [], "raw": "{{baseUrl}}\/api\/one-time-rent\/message" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"request\":11111111,\"service\":\"Unknown\",\"mdn\":\"+1 (609) 555-0123\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"request\":11111111,\"pin\":\"123456\",\"message\":\"Synthetic example message.\"}", "name": "Message received." }, { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"A temporary mobile phone number will only remain active for about 15 minutes\"}", "name": "No message yet." }, { "header": [], "code": 200, "body": "{\"success\":false,\"message\":\"Request not found.\"}", "name": "Legacy not-found response; inspect success as well as HTTP status." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Reject a request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/one-time-rent\/reject", "query": [], "raw": "{{baseUrl}}\/api\/one-time-rent\/reject" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"request\":11111111}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[]}", "name": "Rejected; data is the legacy opaque acknowledgement." }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Bad request.\"}", "name": "Request is not eligible in its current state." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." }, { "header": [], "code": 500, "body": "{\"success\":false,\"message\":\"Server error.\"}", "name": "Request failed; mutation outcomes may be unresolved." }, { "header": [], "code": 503, "body": "{\"success\":false,\"message\":\"Service is unavailable.\"}", "name": "Service unavailable; a mutation may still have an unresolved outcome. Do not retry blindly." } ] }, { "name": "Reuse a one-time number", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/one-time-rent\/reuse", "query": [], "raw": "{{baseUrl}}\/api\/one-time-rent\/reuse" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"request\":11111111,\"service\":\"Unknown\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"mdn\":\"+1 (609) 555-0123\",\"request\":11111111}", "name": "Reused number assigned." }, { "header": [], "code": 201, "body": "{\"success\":true,\"status\":\"Awaiting MDN\",\"request\":11111111}", "name": "Accepted; waiting for number assignment." }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Bad request.\"}", "name": "Request is not eligible in its current state." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 402, "body": "{\"success\":false,\"message\":\"Please add balance to your account to use this service.\"}", "name": "Insufficient available credit." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." }, { "header": [], "code": 503, "body": "{\"success\":false,\"message\":\"Service is unavailable.\"}", "name": "Service unavailable; a mutation may still have an unresolved outcome. Do not retry blindly." } ] }, { "name": "Reply to a one-time rental message", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/one-time-rent\/reply", "query": [], "raw": "{{baseUrl}}\/api\/one-time-rent\/reply" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"request\":11111111,\"message\":\"Text the reply message ...\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Reply has been sent.\"}", "name": "Successful response." }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Bad request.\"}", "name": "Request is not eligible in its current state." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 402, "body": "{\"success\":false,\"message\":\"Please add balance to your account to use this service.\"}", "name": "Insufficient available credit." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." }, { "header": [], "code": 503, "body": "{\"success\":false,\"message\":\"Service is unavailable.\"}", "name": "Service unavailable; a mutation may still have an unresolved outcome. Do not retry blindly." } ] } ] }, { "name": "Long-Term Mobile Rentals", "description": "Purchase and manage 30-day mobile-number rentals, including renewal settings, eligible number changes, messages, and replies.", "item": [ { "name": "Retrieve an existing eSIM activation QR", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/:rental\/esim-qr", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals\/:rental\/esim-qr", "variable": [ { "id": "rental", "key": "rental", "value": "1234", "description": "Owned active long-term rental ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"password\":\"\"}" }, "description": "Requires a bearer token with rentals:read and account password confirmation. Customers and resellers on any portal may retrieve their own eligible active eSIM rental when QR retrieval is enabled. Returns base64 PNG data, not a public activation URL. Does not purchase, issue, replace, or reactivate an eSIM. Limited to five requests per minute, shared with the UI. No Idempotency-Key is required for this read-only retrieval." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"rental_id\":1234,\"mime_type\":\"image\\\/png\",\"image_base64\":\"\"}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"Your password is incorrect.\"}", "name": "Password confirmation failed." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." }, { "header": [], "code": 502, "body": "{\"success\":false,\"message\":\"The eSIM QR code could not be retrieved.\"}", "name": "QR retrieval failed." } ] }, { "name": "Get a long-term rental purchase request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/purchase-requests\/:purchaseRequest", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals\/purchase-requests\/:purchaseRequest", "variable": [ { "id": "purchaseRequest", "key": "purchaseRequest", "value": "123e4567-e89b-42d3-a456-426614174000", "description": "Purchase request UUID; not a rental ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Read-only provisioning status. Use purchase_request_id from the 202 response (the original UUID Idempotency-Key). Poll this GET, not the purchase POST. A missing or non-owned request returns 404. Pending or unknown outcomes must not be retried with a new key." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"purchase_request_id\":\"123e4567-e89b-42d3-a456-426614174000\",\"status\":\"pending\",\"rental_id\":null,\"message\":\"Your rental is being activated.\",\"created_at\":\"2026-10-13T12:00:00-04:00\",\"updated_at\":\"2026-10-13T12:01:00-04:00\"}}", "name": "Pending purchase request." }, { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"purchase_request_id\":\"123e4567-e89b-42d3-a456-426614174000\",\"status\":\"completed\",\"rental_id\":1234,\"message\":\"Your rental is ready.\",\"created_at\":\"2026-10-13T12:00:00-04:00\",\"updated_at\":\"2026-10-13T12:01:00-04:00\"}}", "name": "Completed purchase request." }, { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"purchase_request_id\":\"123e4567-e89b-42d3-a456-426614174000\",\"status\":\"failed\",\"rental_id\":null,\"message\":\"The purchase failed. Contact support before submitting another purchase.\",\"created_at\":\"2026-10-13T12:00:00-04:00\",\"updated_at\":\"2026-10-13T12:01:00-04:00\"}}", "name": "Failed purchase request." }, { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"purchase_request_id\":\"123e4567-e89b-42d3-a456-426614174000\",\"status\":\"unknown\",\"rental_id\":null,\"message\":\"The purchase outcome is not yet confirmed. Do not submit another purchase; contact support if this persists.\",\"created_at\":\"2026-10-13T12:00:00-04:00\",\"updated_at\":\"2026-10-13T12:01:00-04:00\"}}", "name": "Unknown purchase request." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "List available long-term rental products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/products", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals\/products" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"type\":\"unlimited\",\"name\":\"Unlimited\",\"term_days\":30,\"price\":12.5,\"requires\":[],\"location_modes\":[\"any\",\"state\",\"zip\"],\"states\":[\"AL\",\"AK\",\"AZ\",\"AR\",\"CA\",\"CO\",\"CT\",\"DE\",\"DC\",\"FL\",\"GA\",\"HI\",\"ID\",\"IL\",\"IN\",\"IA\",\"KS\",\"KY\",\"LA\",\"ME\",\"MD\",\"MA\",\"MI\",\"MN\",\"MS\",\"MO\",\"MT\",\"NE\",\"NV\",\"NH\",\"NJ\",\"NM\",\"NY\",\"NC\",\"ND\",\"OH\",\"OK\",\"OR\",\"PA\",\"RI\",\"SC\",\"SD\",\"TN\",\"TX\",\"UT\",\"VT\",\"VA\",\"WA\",\"WV\",\"WI\",\"WY\"]}]}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "List long-term rentals", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals", "query": [ { "key": "status", "value": "active", "description": "Filter by active, expired, or rejected.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/long-term-rentals?status=active&page=1&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":1234,\"number\":\"16095550123\",\"product_type\":\"unlimited\",\"service\":\"Unlimited\",\"status\":\"active\",\"auto_renew\":false,\"price\":12.5,\"purchased_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-11-12T12:00:00-05:00\",\"messages_count\":2}],\"meta\":{\"current_page\":1,\"per_page\":25,\"last_page\":1,\"total\":1}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Purchase a long-term rental", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"product_type\":\"unlimited\",\"location_mode\":\"state\",\"state\":\"NY\"}" }, "description": "Requires a unique Idempotency-Key header. Choose any US location (default), a state, or an explicit ZIP code. Location is a preference, not a guaranteed area code." }, "response": [ { "header": [], "code": 202, "body": "{\"success\":true,\"pending\":true,\"purchase_request_id\":\"123e4567-e89b-42d3-a456-426614174000\",\"status_url\":\"\\\/api\\\/long-term-rentals\\\/purchase-requests\\\/123e4567-e89b-42d3-a456-426614174000\",\"message\":\"Your Unlimited SMS mobile number is being provisioned. It will appear here after activation completes.\",\"balance\":75.5}", "name": "Accepted, not activated. Poll status_url." }, { "header": [], "code": 202, "body": "{\"success\":true,\"pending\":true,\"purchase_request_id\":\"123e4567-e89b-42d3-a456-426614174000\",\"status_url\":\"\\\/api\\\/long-term-rentals\\\/purchase-requests\\\/123e4567-e89b-42d3-a456-426614174000\",\"message\":\"The request was not confirmed in time. The activation is being reconciled and your balance remains reserved.\",\"balance\":75.5}", "name": "Acceptance unconfirmed; do not submit another purchase." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 402, "body": "{\"success\":false,\"message\":\"Please add balance to your account to use this service.\"}", "name": "Insufficient available credit." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Get a long-term rental", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/:rental", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals\/:rental", "variable": [ { "id": "rental", "key": "rental", "value": "1234", "description": "Rental ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"id\":1234,\"number\":\"16095550123\",\"product_type\":\"unlimited\",\"service\":\"Unlimited\",\"status\":\"active\",\"auto_renew\":false,\"price\":12.5,\"purchased_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-11-12T12:00:00-05:00\",\"messages_count\":2,\"capabilities\":{\"messages\":true,\"reply\":false,\"renew\":true,\"auto_renew\":true,\"number_change\":false}}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Renew a long-term rental", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/:rental\/renew", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals\/:rental\/renew", "variable": [ { "id": "rental", "key": "rental", "value": "1234", "description": "Rental ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"replayed\":false,\"message\":\"Rental renewed for another term.\",\"expires\":\"11\\\/12\\\/2026 12:00 PM\",\"balance\":50.5}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 402, "body": "{\"success\":false,\"message\":\"Please add balance to your account to use this service.\"}", "name": "Insufficient available credit." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Set automatic renewal", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/:rental\/auto-renew", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals\/:rental\/auto-renew", "variable": [ { "id": "rental", "key": "rental", "value": "1234", "description": "Rental ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"enabled\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"id\":1234,\"number\":\"16095550123\",\"product_type\":\"unlimited\",\"service\":\"Unlimited\",\"status\":\"active\",\"auto_renew\":false,\"price\":12.5,\"purchased_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-11-12T12:00:00-05:00\",\"messages_count\":2}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Request an Unlimited number change", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/:rental\/number-change", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals\/:rental\/number-change", "variable": [ { "id": "rental", "key": "rental", "value": "1234", "description": "Rental ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": null, "description": "Available only when the current Unlimited rental is eligible and number changes are enabled. Requires a unique Idempotency-Key header." }, "response": [ { "header": [], "code": 202, "body": "{\"success\":true,\"pending\":true,\"message\":\"Number change submitted. The new number will appear after confirmation.\"}", "name": "Accepted; read the rental until its number changes. Contact support if unresolved." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "List long-term rental messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/:rental\/messages", "query": [ { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/long-term-rentals\/:rental\/messages?page=1&per_page=25", "variable": [ { "id": "rental", "key": "rental", "value": "1234", "description": "Rental ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":5678,\"direction\":\"inbound\",\"from\":\"16095550999\",\"message\":\"Synthetic example message.\",\"pin\":\"123456\",\"received_at\":\"2026-10-13T12:00:00-04:00\",\"reply_available\":false}],\"meta\":{\"current_page\":1,\"per_page\":25,\"last_page\":1,\"total\":1}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Reply to a long-term rental message", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/long-term-rentals\/:rental\/messages\/:message\/reply", "query": [], "raw": "{{baseUrl}}\/api\/long-term-rentals\/:rental\/messages\/:message\/reply", "variable": [ { "id": "rental", "key": "rental", "value": "1234", "description": "Rental ID." }, { "id": "message", "key": "message", "value": "5678", "description": "Inbound message ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"text\":\"Your verification code was received.\"}" }, "description": "Requires a unique Idempotency-Key header and an eligible rental with outbound messaging enabled." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"sent\":true,\"pending\":false,\"duplicate\":false}", "name": "SMS accepted." }, { "header": [], "code": 202, "body": "{\"success\":true,\"sent\":false,\"pending\":true,\"duplicate\":true}", "name": "Earlier SMS request unresolved; do not send with a new key." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] } ] }, { "name": "Mobile Proxies", "description": "Purchase and manage customer-owned mobile proxies, including plans, locations, credentials, and supported controls.", "item": [ { "name": "List mobile proxy plans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies\/plans", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies\/plans" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":\"day\",\"name\":\"24-Hour\",\"term_minutes\":1440,\"price\":20.5,\"purchase_available\":true,\"renewal_policy\":\"manual\"}]}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." }, { "header": [], "code": 503, "body": "{\"success\":false,\"message\":\"Service is unavailable.\"}", "name": "Service unavailable; a mutation may still have an unresolved outcome. Do not retry blindly." } ] }, { "name": "List current U.S. proxy locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies\/locations", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies\/locations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":\"new_york_1\",\"label\":\"New York, NY\"}]}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." }, { "header": [], "code": 503, "body": "{\"success\":false,\"message\":\"Service is unavailable.\"}", "name": "Service unavailable; a mutation may still have an unresolved outcome. Do not retry blindly." } ] }, { "name": "List mobile proxy orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies", "query": [ { "key": "status", "value": "active", "description": "Filter by active or expired.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/mobile-proxies?status=active&page=1&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"id\":4321,\"plan\":\"day\",\"renewal_status\":\"idle\",\"status\":\"active\",\"price\":20.5,\"term_minutes\":1440,\"started_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-10-14T12:00:00-04:00\",\"location\":\"New York, NY\",\"rotation\":\"10m\",\"rotation_mode\":\"same_city\"}],\"meta\":{\"current_page\":1,\"per_page\":25,\"last_page\":1,\"total\":1}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Purchase a mobile proxy", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"plan\":\"day\",\"location\":\"new_york_1\"}" }, "description": "Requires a unique Idempotency-Key header. Checkout remains fail-closed when availability, customer credit, or account eligibility cannot be verified." }, "response": [ { "header": [], "code": 201, "body": "{\"success\":true,\"data\":{\"id\":4321,\"plan\":\"day\",\"renewal_status\":\"idle\",\"status\":\"active\",\"price\":20.5,\"term_minutes\":1440,\"started_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-10-14T12:00:00-04:00\",\"location\":\"New York, NY\",\"rotation\":\"10m\",\"rotation_mode\":\"same_city\",\"connection\":{\"host\":\"proxy.example.invalid\",\"http_port\":8080,\"socks5_port\":1080,\"username\":\"\",\"password\":\"\"},\"allowlist\":{\"protocol\":\"socks5\",\"addresses\":[\"203.0.113.10\"]},\"renewal\":{\"available\":true,\"status\":\"available\",\"price\":20.5,\"term_minutes\":1440,\"policy\":\"manual\"},\"capabilities\":{\"renew\":true,\"rotate\":true,\"relocate\":true,\"schedule_rotation\":true,\"allowlist\":true}}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 402, "body": "{\"success\":false,\"message\":\"Please add balance to your account to use this service.\"}", "name": "Insufficient available credit." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Get a mobile proxy", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies\/:proxy", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies\/:proxy", "variable": [ { "id": "proxy", "key": "proxy", "value": "4321", "description": "Mobile proxy order ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":{\"id\":4321,\"plan\":\"day\",\"renewal_status\":\"idle\",\"status\":\"active\",\"price\":20.5,\"term_minutes\":1440,\"started_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-10-14T12:00:00-04:00\",\"location\":\"New York, NY\",\"rotation\":\"10m\",\"rotation_mode\":\"same_city\",\"connection\":{\"host\":\"proxy.example.invalid\",\"http_port\":8080,\"socks5_port\":1080,\"username\":\"\",\"password\":\"\"},\"allowlist\":{\"protocol\":\"socks5\",\"addresses\":[\"203.0.113.10\"]},\"renewal\":{\"available\":true,\"status\":\"available\",\"price\":20.5,\"term_minutes\":1440,\"policy\":\"manual\"},\"capabilities\":{\"renew\":true,\"rotate\":true,\"relocate\":true,\"schedule_rotation\":true,\"allowlist\":true}}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Renew a mobile proxy", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies\/:proxy\/renew", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies\/:proxy\/renew", "variable": [ { "id": "proxy", "key": "proxy", "value": "4321", "description": "Existing mobile proxy order ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"max_price\":20}" }, "description": "Extends the existing active proxy for its current plan. Requires Idempotency-Key and max_price. On an uncertain outcome, credit stays reserved and no second renewal is sent. Auto-renew and expired-proxy recovery are not supported." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Mobile proxy renewed.\",\"data\":{\"id\":4321,\"plan\":\"day\",\"renewal_status\":\"idle\",\"status\":\"active\",\"price\":20.5,\"term_minutes\":1440,\"started_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-10-14T12:00:00-04:00\",\"location\":\"New York, NY\",\"rotation\":\"10m\",\"rotation_mode\":\"same_city\",\"connection\":{\"host\":\"proxy.example.invalid\",\"http_port\":8080,\"socks5_port\":1080,\"username\":\"\",\"password\":\"\"},\"allowlist\":{\"protocol\":\"socks5\",\"addresses\":[\"203.0.113.10\"]},\"renewal\":{\"available\":true,\"status\":\"available\",\"price\":20.5,\"term_minutes\":1440,\"policy\":\"manual\"},\"capabilities\":{\"renew\":true,\"rotate\":true,\"relocate\":true,\"schedule_rotation\":true,\"allowlist\":true}}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 402, "body": "{\"success\":false,\"message\":\"Please add balance to your account to use this service.\"}", "name": "Insufficient available credit." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Rotate a mobile proxy IP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies\/:proxy\/rotate", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies\/:proxy\/rotate", "variable": [ { "id": "proxy", "key": "proxy", "value": "4321", "description": "Active mobile proxy order ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": null, "description": "Requires a unique Idempotency-Key header." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Proxy IP change requested.\",\"data\":{\"id\":4321,\"plan\":\"day\",\"renewal_status\":\"idle\",\"status\":\"active\",\"price\":20.5,\"term_minutes\":1440,\"started_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-10-14T12:00:00-04:00\",\"location\":\"New York, NY\",\"rotation\":\"10m\",\"rotation_mode\":\"same_city\",\"connection\":{\"host\":\"proxy.example.invalid\",\"http_port\":8080,\"socks5_port\":1080,\"username\":\"\",\"password\":\"\"},\"allowlist\":{\"protocol\":\"socks5\",\"addresses\":[\"203.0.113.10\"]},\"renewal\":{\"available\":true,\"status\":\"available\",\"price\":20.5,\"term_minutes\":1440,\"policy\":\"manual\"},\"capabilities\":{\"renew\":true,\"rotate\":true,\"relocate\":true,\"schedule_rotation\":true,\"allowlist\":true}}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Change a mobile proxy location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies\/:proxy\/location", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies\/:proxy\/location", "variable": [ { "id": "proxy", "key": "proxy", "value": "4321", "description": "Active mobile proxy order ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"location\":\"new_york_1\"}" }, "description": "Requires a unique Idempotency-Key header." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Proxy location updated.\",\"data\":{\"id\":4321,\"plan\":\"day\",\"renewal_status\":\"idle\",\"status\":\"active\",\"price\":20.5,\"term_minutes\":1440,\"started_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-10-14T12:00:00-04:00\",\"location\":\"New York, NY\",\"rotation\":\"10m\",\"rotation_mode\":\"same_city\",\"connection\":{\"host\":\"proxy.example.invalid\",\"http_port\":8080,\"socks5_port\":1080,\"username\":\"\",\"password\":\"\"},\"allowlist\":{\"protocol\":\"socks5\",\"addresses\":[\"203.0.113.10\"]},\"renewal\":{\"available\":true,\"status\":\"available\",\"price\":20.5,\"term_minutes\":1440,\"policy\":\"manual\"},\"capabilities\":{\"renew\":true,\"rotate\":true,\"relocate\":true,\"schedule_rotation\":true,\"allowlist\":true}}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Set a mobile proxy rotation schedule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies\/:proxy\/rotation", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies\/:proxy\/rotation", "variable": [ { "id": "proxy", "key": "proxy", "value": "4321", "description": "Active mobile proxy order ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"rotation\":\"10m\",\"mode\":\"same_city\"}" }, "description": "Requires a unique Idempotency-Key header." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Proxy rotation schedule updated.\",\"data\":{\"id\":4321,\"plan\":\"day\",\"renewal_status\":\"idle\",\"status\":\"active\",\"price\":20.5,\"term_minutes\":1440,\"started_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-10-14T12:00:00-04:00\",\"location\":\"New York, NY\",\"rotation\":\"10m\",\"rotation_mode\":\"same_city\",\"connection\":{\"host\":\"proxy.example.invalid\",\"http_port\":8080,\"socks5_port\":1080,\"username\":\"\",\"password\":\"\"},\"allowlist\":{\"protocol\":\"socks5\",\"addresses\":[\"203.0.113.10\"]},\"renewal\":{\"available\":true,\"status\":\"available\",\"price\":20.5,\"term_minutes\":1440,\"policy\":\"manual\"},\"capabilities\":{\"renew\":true,\"rotate\":true,\"relocate\":true,\"schedule_rotation\":true,\"allowlist\":true}}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] }, { "name": "Replace or disable a mobile proxy IPv4 allowlist", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/mobile-proxies\/:proxy\/allowlist", "query": [], "raw": "{{baseUrl}}\/api\/mobile-proxies\/:proxy\/allowlist", "variable": [ { "id": "proxy", "key": "proxy", "value": "4321", "description": "Active mobile proxy order ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "Idempotency-Key", "value": "123e4567-e89b-42d3-a456-426614174000" } ], "body": { "mode": "raw", "raw": "{\"addresses\":[\"203.0.113.10\"],\"protocol\":\"socks5\"}" }, "description": "Requires a unique Idempotency-Key header." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Proxy IPv4 allowlist replaced.\",\"data\":{\"id\":4321,\"plan\":\"day\",\"renewal_status\":\"idle\",\"status\":\"active\",\"price\":20.5,\"term_minutes\":1440,\"started_at\":\"2026-10-13T12:00:00-04:00\",\"expires_at\":\"2026-10-14T12:00:00-04:00\",\"location\":\"New York, NY\",\"rotation\":\"10m\",\"rotation_mode\":\"same_city\",\"connection\":{\"host\":\"proxy.example.invalid\",\"http_port\":8080,\"socks5_port\":1080,\"username\":\"\",\"password\":\"\"},\"allowlist\":{\"protocol\":\"socks5\",\"addresses\":[\"203.0.113.10\"]},\"renewal\":{\"available\":true,\"status\":\"available\",\"price\":20.5,\"term_minutes\":1440,\"policy\":\"manual\"},\"capabilities\":{\"renew\":true,\"rotate\":true,\"relocate\":true,\"schedule_rotation\":true,\"allowlist\":true}}}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Resource does not exist, is not owned by this account, or is ineligible for this action." }, { "header": [], "code": 409, "body": "{\"success\":false,\"message\":\"This operation is already in progress or has an unknown outcome. Contact support before retrying.\"}", "name": "Key conflict or unresolved outcome; do not retry with a new key." }, { "header": [], "code": 422, "body": "{\"success\":false,\"message\":\"A valid Idempotency-Key header is required for this operation.\"}", "name": "Missing\/invalid key or business-rule rejection." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"field\":[\"The field is invalid.\"]}}", "name": "Validation failed; errors is a map of field names to message arrays." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] } ] }, { "name": "One-Time Rates", "description": "List current customer pricing and availability for one-time mobile rentals.", "item": [ { "name": "One-time Number Rates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rates\/mobiles_rentals", "query": [], "raw": "{{baseUrl}}\/api\/rates\/mobiles_rentals" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"data\":[{\"service\":\"Unknown\",\"price\":\"$0.5\",\"available\":1}]}", "name": "Successful response." }, { "header": [], "code": 401, "body": "{\"success\":false,\"message\":\"Unauthorized.\"}", "name": "Bearer token missing, invalid or expired." }, { "header": [], "code": 403, "body": "{\"success\":false,\"message\":\"This token does not have the required ability.\"}", "name": "Account, role, portal or token ability does not permit this operation." }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Rate limited. Respect Retry-After. Shared API limit: 240\/minute; token issuance: 10\/minute per login\/IP; QR: 5\/minute per account." } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "type": "string" } ] } }