Update add-on partially
curl --request PATCH \
--url https://apiweb.mile.app/api/v3/addon/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Delivery Summary Widget",
"description": "Shows today's finished deliveries per hub"
}
EOFimport requests
url = "https://apiweb.mile.app/api/v3/addon/{id}"
payload = {
"name": "Delivery Summary Widget",
"description": "Shows today's finished deliveries per hub"
}
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: 'Delivery Summary Widget',
description: 'Shows today\'s finished deliveries per hub'
})
};
fetch('https://apiweb.mile.app/api/v3/addon/{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_URL => "https://apiweb.mile.app/api/v3/addon/{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' => 'Delivery Summary Widget',
'description' => 'Shows today\'s finished deliveries per hub'
]),
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 := "https://apiweb.mile.app/api/v3/addon/{id}"
payload := strings.NewReader("{\n \"name\": \"Delivery Summary Widget\",\n \"description\": \"Shows today's finished deliveries per hub\"\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("https://apiweb.mile.app/api/v3/addon/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Delivery Summary Widget\",\n \"description\": \"Shows today's finished deliveries per hub\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiweb.mile.app/api/v3/addon/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Delivery Summary Widget\",\n \"description\": \"Shows today's finished deliveries per hub\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Add-on has been updated successfully.",
"data": {
"_id": "68b440c9dad4c5d45707f6d2",
"name": "Delivery Summary Widget",
"description": "Shows today's finished deliveries per hub",
"resourceFile": "1756656087_Delivery-Summary-Widget.js",
"organizationId": "64d99303be0ad015c461c932",
"createdBy": "[email protected]",
"updatedBy": "[email protected]",
"updatedTime": "2026-10-16T03:10:00.000000Z",
"createdTime": "2026-08-31T10:30:00.000000Z"
}
}{
"status": false,
"message": "Bad request - invalid parameters provided."
}{
"status": false,
"message": "Internal server error, please contact [email protected]."
}Add-ons
Update add-on partially
Changes only the name and/or description of an add-on that belongs to your organization. Fields you leave out keep their current value.
Requires permission edit/addon.
On /api/v3, add-ons created in the new web app are not found; call /api/v4/addon/{id} for those.
PATCH
/
addon
/
{id}
Update add-on partially
curl --request PATCH \
--url https://apiweb.mile.app/api/v3/addon/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Delivery Summary Widget",
"description": "Shows today's finished deliveries per hub"
}
EOFimport requests
url = "https://apiweb.mile.app/api/v3/addon/{id}"
payload = {
"name": "Delivery Summary Widget",
"description": "Shows today's finished deliveries per hub"
}
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: 'Delivery Summary Widget',
description: 'Shows today\'s finished deliveries per hub'
})
};
fetch('https://apiweb.mile.app/api/v3/addon/{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_URL => "https://apiweb.mile.app/api/v3/addon/{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' => 'Delivery Summary Widget',
'description' => 'Shows today\'s finished deliveries per hub'
]),
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 := "https://apiweb.mile.app/api/v3/addon/{id}"
payload := strings.NewReader("{\n \"name\": \"Delivery Summary Widget\",\n \"description\": \"Shows today's finished deliveries per hub\"\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("https://apiweb.mile.app/api/v3/addon/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Delivery Summary Widget\",\n \"description\": \"Shows today's finished deliveries per hub\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiweb.mile.app/api/v3/addon/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Delivery Summary Widget\",\n \"description\": \"Shows today's finished deliveries per hub\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Add-on has been updated successfully.",
"data": {
"_id": "68b440c9dad4c5d45707f6d2",
"name": "Delivery Summary Widget",
"description": "Shows today's finished deliveries per hub",
"resourceFile": "1756656087_Delivery-Summary-Widget.js",
"organizationId": "64d99303be0ad015c461c932",
"createdBy": "[email protected]",
"updatedBy": "[email protected]",
"updatedTime": "2026-10-16T03:10:00.000000Z",
"createdTime": "2026-08-31T10:30:00.000000Z"
}
}{
"status": false,
"message": "Bad request - invalid parameters provided."
}{
"status": false,
"message": "Internal server error, please contact [email protected]."
}Authorizations
Use a valid Bearer token to authenticate.
Path Parameters
Add-on ID.
Example: 68b440c9dad4c5d45707f6d2