Update a mini app's name, description, or icon
curl --request PATCH \
--url http://localhost:8080/mini-apps/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"enabled_channels": []
}
'import requests
url = "http://localhost:8080/mini-apps/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"enabled_channels": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', description: '<string>', enabled_channels: []})
};
fetch('http://localhost:8080/mini-apps/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/mini-apps/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'enabled_channels' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/mini-apps/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled_channels\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://localhost:8080/mini-apps/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled_channels\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/mini-apps/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled_channels\": []\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"enabled_channels": [
"<string>"
],
"icon": "ChartBar"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Mini-apps
Update mini-app details
Update a mini-app’s name, description, or icon with edit access. Viewing access alone does not authorize changes to the app.
PATCH
/
mini-apps
/
{id}
Update a mini app's name, description, or icon
curl --request PATCH \
--url http://localhost:8080/mini-apps/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"enabled_channels": []
}
'import requests
url = "http://localhost:8080/mini-apps/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"enabled_channels": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', description: '<string>', enabled_channels: []})
};
fetch('http://localhost:8080/mini-apps/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/mini-apps/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'enabled_channels' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/mini-apps/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled_channels\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://localhost:8080/mini-apps/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled_channels\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/mini-apps/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled_channels\": []\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"enabled_channels": [
"<string>"
],
"icon": "ChartBar"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}The acting user must have
mini-apps:write. An empty editor list allows everyone with that permission. When the list is nonempty, only selected editors and the owner can edit. Bare API keys and users excluded by a restricted list receive 403. The owner can invite eligible teammates from Share → Can edit.
See Mini-app editing access for invitations, ownership
transfer, and the difference between viewing and editing.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
Required string length:
1 - 120Maximum string length:
2000Available options:
web, email, phone_voice, slack, sms, whatsapp, instagram, messenger, api, web_voice, twitter, twitter_mentions, app_review, internal Available options:
ChartBar, ChartBarHorizontal, ChartLine, ChartLineUp, ChartPie, ChartDonut, ChartScatter, ChartPolar, TrendUp, TrendDown, Graph, Table, ListBullets, Kanban, Funnel, Gauge, Pulse, Percent, Calculator, Target, Crosshair, Timer, Clock, CalendarBlank, Users, UsersThree, User, UserCircle, IdentificationBadge, Headset, Handshake, Chat, ChatsTeardrop, Envelope, Phone, Globe, Megaphone, PaperPlaneTilt, Bell, Star, Heart, Smiley, ThumbsUp, Warning, ShieldCheck, Trophy, Medal, Flag, Fire, Rocket, Lightning, Sparkle, Robot, Brain, MagicWand, Atom, Lightbulb, Money, CurrencyDollar, Coins, CreditCard, Receipt, ShoppingCart, Package, Truck, Storefront, Buildings, MapPin, Tag, Bookmark, Ticket, Database, Stack, Cube, Wrench, Gear, Flask, FileText, ClipboardText, Notebook, SquaresFour, TreeStructure, Eye, Binoculars, Compass, Scales, Question, Info Response
Default Response
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
ChartBar, ChartBarHorizontal, ChartLine, ChartLineUp, ChartPie, ChartDonut, ChartScatter, ChartPolar, TrendUp, TrendDown, Graph, Table, ListBullets, Kanban, Funnel, Gauge, Pulse, Percent, Calculator, Target, Crosshair, Timer, Clock, CalendarBlank, Users, UsersThree, User, UserCircle, IdentificationBadge, Headset, Handshake, Chat, ChatsTeardrop, Envelope, Phone, Globe, Megaphone, PaperPlaneTilt, Bell, Star, Heart, Smiley, ThumbsUp, Warning, ShieldCheck, Trophy, Medal, Flag, Fire, Rocket, Lightning, Sparkle, Robot, Brain, MagicWand, Atom, Lightbulb, Money, CurrencyDollar, Coins, CreditCard, Receipt, ShoppingCart, Package, Truck, Storefront, Buildings, MapPin, Tag, Bookmark, Ticket, Database, Stack, Cube, Wrench, Gear, Flask, FileText, ClipboardText, Notebook, SquaresFour, TreeStructure, Eye, Binoculars, Compass, Scales, Question, Info Was this page helpful?