Get
/apps/buildExternalAppRequest
Build an external app request form. This endpoint returns a link that workspace users can use to request an app externally without being in Rocket.Chat.
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Responses
200
OK
External URL to request app
{
"url": "https://marketplace.rocket.chat/apps/ce0e318b-ffc0-4ce4-832b-f1b464beb22a/requestAccess?workspaceId=64df890111e1f20001d201b4&frameworkVersion=1.59.0&requester=eyJpZCI6ImtiMldCa2prdXQ0WUpwRlFrIiwidXNlcm5hbWUiOiJhZ2VudDIiLCJuYW1lIjoiVGVzdCBVc2VyIDUiLCJlbWFpbHMiOlsiYWdlbnQyQGFnZW50LmNvbSJdfQ%3D%3D&admins=W3siaWQiOiJQMmRnV1BQdzV2ZWlnd2NkSyIsInVzZXJuYW1lIjoiZnVua2Uub2xhc3VwbyIsIm5hbWUiOiJUZXN0IFVzZXIgMyJ9LHsiaWQiOiJxSFdob0p3d2drNGJ3Y29OcSIsInVzZXJuYW1lIjoib2x1ZnVua2UiLCJuYW1lIjoiT2x1ZnVua2UifSx7ImlkIjoiTUVwc3dGZnI1dTNXUGVYcWIiLCJ1c2VybmFtZSI6ImZhcmlhIiwibmFtZSI6IkZhcmlhIn0seyJpZCI6IkMzOFdTU3pyR2QyTkNqenFKIiwidXNlcm5hbWUiOiJ0ZXN0LmNhdCIsIm5hbWUiOiJ0ZXN0IGNhdCIsIm5pY2tuYW1lIjoiY2FrZSJ9LHsiaWQiOiJhblpDalQzeUpDTmphUGtvbyIsInVzZXJuYW1lIjoia2V2aW4uc3VwZXJtYW4iLCJuYW1lIjoia2V2aW4uc3VwZXJtYW4ifSx7ImlkIjoiY2tON3BuOHFrS3BQb0hZUXkiLCJ1c2VybmFtZSI6InRlc3QuZ3VzdGF2byIsIm5hbWUiOiJHdXN0YXZvIn0seyJpZCI6Ik1mYnZtRE12Y1d6eHdpakFzIiwidXNlcm5hbWUiOiJ1c2VyMTEiLCJuYW1lIjoidXNlciBqb24ifSx7ImlkIjoiQWhnZjVrOUNhNFlFZE1qd1giLCJ1c2VybmFtZSI6ImF5dGFqIiwibmFtZSI6IkF5dGFqIn0seyJpZCI6ImFQaHJQWndlVDk2cUxuUjdNIiwidXNlcm5hbWUiOiJzYXJhaC53aWxsaWFtcyIsIm5hbWUiOiJTYXJhaCBXaWxsaWFtcyJ9LHsiaWQiOiJqdmdXbWpjOFRCdDVMWWFqRiIsInVzZXJuYW1lIjoieW9uZy5oaW5keSIsIm5hbWUiOiJZb25nIEhpbmR5In1d",
"success": true
}object
url
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string