> For the complete documentation index, see [llms.txt](https://developers.mobile-text-alerts.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.mobile-text-alerts.com/api-reference/deeplinks.md). # Deeplinks * Create Deeplink [#post-deeplinks](#post-deeplinks "mention") * Create iMessage Deeplink [#post-deeplinks-imessage](#post-deeplinks-imessage "mention") ## Create Deeplink > \*\*This feature is currently in closed beta\*\*. Please contact your MTA account rep or MTA support for more information. > \\ > > \ > \### Request Body > \\ > > \ > \- \`androidURI\`: The deeplink URI for Android. > \\ > > \ > \- \`iosURI\`: The deeplink URI for iOS. > \\ > > \ > \- \`macURI\`: The deeplink URI for Mac. > \\ > > \ > \- \`windowsURI\`: The deeplink URI for Windows. > \\ > > \ > \- \`defaultURI\`: The default deeplink URI. > \\ > > \\ > > \ > \### Response > \\ > > \ > Upon successful creation, the response will include the \`deeplinkUrl\` > \\ > > \ > \#### Example > \\ > > \ > Request: > \\ > > \ > \`\`\` json > \ > { > \ > "androidURI": "sms:+15555555555?body=Example", > \ > "iosURI": "imessage://imessage\@example.com?body=Example", > \ > "macURI": "", > \ > "windowsURI": "", > \ > "defaultURI": "" > \ > } > \\ > > \ > \`\`\` > \\ > > \ > Response: > \\ > > \ > \`\`\` json > \ > { > \ > "deeplinkUrl": "" > \ > } > \\ > > \ > \`\`\` ````json {"openapi":"3.0.0","info":{"title":"Mobile Text Alerts API","version":"8.0.0"},"servers":[{"url":"https://api.mobile-text-alerts.com/v3"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"apiKey"}},"schemas":{"CreateDeeplink.Response":{"allOf":[{"$ref":"#/components/schemas/IApiResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"deeplinkUrl":{"type":"string"}},"required":["deeplinkUrl"]}},"required":["data"]}]},"IApiResponse":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"data":{}}},"CreateDeeplinkRequest":{"type":"object","properties":{"androidURI":{"type":"string"},"iosURI":{"type":"string"},"macURI":{"type":"string"},"windowsURI":{"type":"string"},"defaultURI":{"type":"string"}},"required":["androidURI","iosURI","macURI","windowsURI","defaultURI"]}},"responses":{"BadRequestError":{"description":"BadRequestError","content":{"application/json":{"schema":{"type":"object","properties":{"httpCode":{"type":"number","enum":[400]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["bad_request_error"]},"name":{"type":"string","enum":["MTABadRequestError"]},"requestId":{"type":"string","format":"uuid"}}}}}},"UnauthorizedError":{"description":"UnauthorizedError","content":{"application/json":{"schema":{"type":"object","properties":{"httpCode":{"type":"number","enum":[401]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["unauthorized_error"]},"name":{"type":"string","enum":["MTAUnauthorizedError"]},"requestId":{"type":"string","format":"uuid"}}}}}},"ForbiddenError":{"description":"ForbiddenError","content":{"application/json":{"schema":{"type":"object","properties":{"httpCode":{"type":"number","enum":[403]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["forbidden_error"]},"name":{"type":"string","enum":["MTAForbiddenError"]},"requestId":{"type":"string","format":"uuid"},"reason":{}}}}}},"InternalServerError":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","properties":{"httpCode":{"type":"number","enum":[500]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["internal_server_error"]},"name":{"type":"string","enum":["MTAInternalServerError"]},"requestId":{"type":"string","format":"uuid"}}}}}}}},"paths":{"/deeplinks":{"post":{"tags":["Deeplinks"],"summary":"Create Deeplink","operationId":"deeplinks_create_deeplink","responses":{"200":{"description":"Success","headers":{"RateLimit-Limit":{"description":"The maximum number of requests that the consumer is permitted to make per window","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the current rate limit window","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"The remaining window before the rate limit resets in milliseconds","schema":{"type":"integer"}},"Retry-After":{"description":"The number of seconds to wait before retrying the request","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"The maximum number of requests that the consumer is permitted to make per window","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current rate limit window","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The remaining window before the rate limit resets in milliseconds","schema":{"type":"integer"}},"X-Request-ID":{"description":"A unique identifier for the request","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeeplink.Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeeplinkRequest"}}},"required":true},"description":"**This feature is currently in closed beta**. Please contact your MTA account rep or MTA support for more information.\r\n\r\n### Request Body\r\n\r\n- `androidURI`: The deeplink URI for Android.\r\n\r\n- `iosURI`: The deeplink URI for iOS.\r\n\r\n- `macURI`: The deeplink URI for Mac.\r\n\r\n- `windowsURI`: The deeplink URI for Windows.\r\n\r\n- `defaultURI`: The default deeplink URI.\r\n\r\n\r\n### Response\r\n\r\nUpon successful creation, the response will include the `deeplinkUrl`\r\n\r\n#### Example\r\n\r\nRequest:\r\n\r\n``` json\r\n{\r\n \"androidURI\": \"sms:+15555555555?body=Example\",\r\n \"iosURI\": \"imessage://imessage@example.com?body=Example\",\r\n \"macURI\": \"https://mobile-text-alerts.com/example\",\r\n \"windowsURI\": \"https://mobile-text-alerts.com/example\",\r\n \"defaultURI\": \"https://mobile-text-alerts.com/example\"\r\n}\r\n\r\n ```\r\n\r\nResponse:\r\n\r\n``` json\r\n{\r\n \"deeplinkUrl\": \"https://platform.mobile-text-alerts.com/deeplinks/abc\"\r\n}\r\n\r\n ```"}}}} ```` ## Create IMessage Deeplink > \*\*This feature is currently in closed beta\*\*. Please contact your MTA account rep or MTA support for more information. > \\ > > \ > \### Request Body > \\ > > \ > \- \`longcodeId\`: The id of the longcode. > \\ > > \ > \- \`optInMessage\`: The opt-in message used to populate the deeplink urls. > \\ > > \ > \- \`senderName\`: The sender name used to pre-populate the "To:" field for iMessage > \ > \- If this field is empty, the sender name associated with the longcode will be used as the default. > \\ > > \\ > > \ > \### Response > \\ > > \ > Upon successful creation, the response will include the \`deeplinkUrl\` > \\ > > \ > \#### Example > \\ > > \ > Request: > \\ > > \ > \`\`\` json > \ > { > \ > "longcodeId": 1337, > \ > "optInMessage": "Example", > \ > "senderName": "" > \ > } > \\ > > \ > \`\`\` > \\ > > \ > Response: > \\ > > \ > \`\`\` json > \ > { > \ > "deeplinkUrl": "" > \ > } > \\ > > \ > \`\`\` ````json {"openapi":"3.0.0","info":{"title":"Mobile Text Alerts API","version":"8.0.0"},"servers":[{"url":"https://api.mobile-text-alerts.com/v3"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"apiKey"}},"schemas":{"CreateIMessageDeeplink.Response":{"allOf":[{"$ref":"#/components/schemas/IApiResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"deeplinkUrl":{"type":"string"}},"required":["deeplinkUrl"]}},"required":["data"]}]},"IApiResponse":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"data":{}}},"CreateIMessageDeeplinkRequest":{"type":"object","properties":{"longcodeId":{"type":"number"},"optInMessage":{"type":"string"},"senderName":{"type":"string"}},"required":["optInMessage"]}},"responses":{"BadRequestError":{"description":"BadRequestError","content":{"application/json":{"schema":{"type":"object","properties":{"httpCode":{"type":"number","enum":[400]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["bad_request_error"]},"name":{"type":"string","enum":["MTABadRequestError"]},"requestId":{"type":"string","format":"uuid"}}}}}},"UnauthorizedError":{"description":"UnauthorizedError","content":{"application/json":{"schema":{"type":"object","properties":{"httpCode":{"type":"number","enum":[401]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["unauthorized_error"]},"name":{"type":"string","enum":["MTAUnauthorizedError"]},"requestId":{"type":"string","format":"uuid"}}}}}},"ForbiddenError":{"description":"ForbiddenError","content":{"application/json":{"schema":{"type":"object","properties":{"httpCode":{"type":"number","enum":[403]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["forbidden_error"]},"name":{"type":"string","enum":["MTAForbiddenError"]},"requestId":{"type":"string","format":"uuid"},"reason":{}}}}}},"InternalServerError":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","properties":{"httpCode":{"type":"number","enum":[500]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["internal_server_error"]},"name":{"type":"string","enum":["MTAInternalServerError"]},"requestId":{"type":"string","format":"uuid"}}}}}}}},"paths":{"/deeplinks/imessage":{"post":{"tags":["Deeplinks"],"summary":"Create IMessage Deeplink","operationId":"deeplinks_create_i_message_deeplink","responses":{"200":{"description":"Success","headers":{"RateLimit-Limit":{"description":"The maximum number of requests that the consumer is permitted to make per window","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The number of requests remaining in the current rate limit window","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"The remaining window before the rate limit resets in milliseconds","schema":{"type":"integer"}},"Retry-After":{"description":"The number of seconds to wait before retrying the request","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"The maximum number of requests that the consumer is permitted to make per window","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current rate limit window","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The remaining window before the rate limit resets in milliseconds","schema":{"type":"integer"}},"X-Request-ID":{"description":"A unique identifier for the request","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIMessageDeeplink.Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIMessageDeeplinkRequest"}}},"required":true},"description":"**This feature is currently in closed beta**. Please contact your MTA account rep or MTA support for more information.\r\n\r\n### Request Body\r\n\r\n- `longcodeId`: The id of the longcode.\r\n\r\n- `optInMessage`: The opt-in message used to populate the deeplink urls.\r\n\r\n- `senderName`: The sender name used to pre-populate the \"To:\" field for iMessage\r\n - If this field is empty, the sender name associated with the longcode will be used as the default.\r\n\r\n\r\n### Response\r\n\r\nUpon successful creation, the response will include the `deeplinkUrl`\r\n\r\n#### Example\r\n\r\nRequest:\r\n\r\n``` json\r\n{\r\n \"longcodeId\": 1337,\r\n \"optInMessage\": \"Example\",\r\n \"senderName\": \"example@i-msg.co\"\r\n}\r\n\r\n ```\r\n\r\nResponse:\r\n\r\n``` json\r\n{\r\n \"deeplinkUrl\": \"https://platform.mobile-text-alerts.com/deeplinks/abc\"\r\n}\r\n\r\n ```"}}}} ```` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developers.mobile-text-alerts.com/api-reference/deeplinks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.