PATCH
/
projects
/
{projectIdOrName}
Update a project
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",
    "name"
  ],
  "project": {
    "appName": "MailMonkey",
    "name": "mailmonkey-staging"
  }
}'
{
  "id": "my-project",
  "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
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

Body

application/json
​
updateMask
string[]
required

Array of field paths specifying which fields to update. Allowed values include:

  • appName
  • name
Example:
["appName", "name"]
​
project
object
required

The project fields to update. (Only include the fields you'd like to update.)

Response

The updated project.

​
id
string
required

The project ID.

Example:

"my-project"

​
name
string
required

The project name.

Example:

"mailmonkey-staging"

​
appName
string
required

The name of the application, which is displayed to end users.

Example:

"MailMonkey"

​
createTime
string<date-time>
required

The time the project was created.

​
orgId
string

The organization ID that this project belongs to.

Example:

"9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79"

​
updateTime
string<date-time>

The time the project was updated.

​
entitlements
object

The entitlements for the project.