PATCH
/
projects
/
{projectIdOrName}
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",
    "name": "mailmonkey-staging"
  }
}'
{
  "id": "project-id-123",
  "name": "mailmonkey-staging",
  "appName": "MailMonkey",
  "orgId": "<string>",
  "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

Body

application/json
​
updateMask
string[]
required

fields to update.

Example:
["appName"]
​
project
object
required

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

Response

200
application/json
The updated project
​
id
string
required

The project ID.

Example:

"project-id-123"

​
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
required

The time the project was created.

​
orgId
string

The organization ID that this project belongs to.

​
updateTime
string

The time the project was updated.

​
entitlements
object

The entitlements for the project.

Was this page helpful?

Suggest editsRaise issue