curl --request PATCH \
--url https://api.withampersand.com/v1/projects/{projectIdOrName} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"updateMask": [
"appName"
],
"project": {
"appName": "MailMonkey Pro"
}
}
'import requests
url = "https://api.withampersand.com/v1/projects/{projectIdOrName}"
payload = {
"updateMask": ["appName"],
"project": { "appName": "MailMonkey Pro" }
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({updateMask: ['appName'], project: {appName: 'MailMonkey Pro'}})
};
fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}', 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://api.withampersand.com/v1/projects/{projectIdOrName}",
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([
'updateMask' => [
'appName'
],
'project' => [
'appName' => 'MailMonkey Pro'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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://api.withampersand.com/v1/projects/{projectIdOrName}"
payload := strings.NewReader("{\n \"updateMask\": [\n \"appName\"\n ],\n \"project\": {\n \"appName\": \"MailMonkey Pro\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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://api.withampersand.com/v1/projects/{projectIdOrName}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"updateMask\": [\n \"appName\"\n ],\n \"project\": {\n \"appName\": \"MailMonkey Pro\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"updateMask\": [\n \"appName\"\n ],\n \"project\": {\n \"appName\": \"MailMonkey Pro\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "proj_9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79",
"name": "mailmonkey-staging",
"appName": "MailMonkey",
"orgId": "9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79",
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"entitlements": {
"brandingRemoval": {
"value": true
}
}
}{
"type": "urn:problem-type:exampleOrganization:exampleProblem",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Description of the type of problem that occurred",
"status": 400,
"detail": "Description of specific occurrence of the problem",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}Update a project
Update a project’s mutable fields using field masks. Currently, the updatable fields are appName (the display name shown to end users) and name (the unique project identifier).
curl --request PATCH \
--url https://api.withampersand.com/v1/projects/{projectIdOrName} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"updateMask": [
"appName"
],
"project": {
"appName": "MailMonkey Pro"
}
}
'import requests
url = "https://api.withampersand.com/v1/projects/{projectIdOrName}"
payload = {
"updateMask": ["appName"],
"project": { "appName": "MailMonkey Pro" }
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({updateMask: ['appName'], project: {appName: 'MailMonkey Pro'}})
};
fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}', 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://api.withampersand.com/v1/projects/{projectIdOrName}",
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([
'updateMask' => [
'appName'
],
'project' => [
'appName' => 'MailMonkey Pro'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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://api.withampersand.com/v1/projects/{projectIdOrName}"
payload := strings.NewReader("{\n \"updateMask\": [\n \"appName\"\n ],\n \"project\": {\n \"appName\": \"MailMonkey Pro\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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://api.withampersand.com/v1/projects/{projectIdOrName}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"updateMask\": [\n \"appName\"\n ],\n \"project\": {\n \"appName\": \"MailMonkey Pro\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"updateMask\": [\n \"appName\"\n ],\n \"project\": {\n \"appName\": \"MailMonkey Pro\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "proj_9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79",
"name": "mailmonkey-staging",
"appName": "MailMonkey",
"orgId": "9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79",
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"entitlements": {
"brandingRemoval": {
"value": true
}
}
}{
"type": "urn:problem-type:exampleOrganization:exampleProblem",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Description of the type of problem that occurred",
"status": 400,
"detail": "Description of specific occurrence of the problem",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}Authorizations
Path Parameters
The Ampersand project ID or project name.
Body
Array of field paths specifying which fields to update. Each path must have a
corresponding value in the project object. A field included in project but
not listed here will be ignored. Allowed values:
appName- the display name of the application, shown to end users during the connection flow.name- the unique project identifier (must be unique within your organization).
["appName"]
The project fields to update. Only fields whose paths are listed in updateMask
will be applied; all other fields in this object are ignored.
Show child attributes
Show child attributes
Response
The updated project.
The unique identifier for the project.
"proj_9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79"
The unique name for the project.
"mailmonkey-staging"
The display name of the application, shown to end users during the connection flow.
"MailMonkey"
The ID of the organization that this project belongs to.
"9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79"
The time the project was created.
The time the project was updated.
Plan-based feature flags for the project. These are managed by Ampersand and cannot be set via the API.
Show child attributes
Show child attributes
Was this page helpful?

