Change the project

PATCH

/v1/project

curl --request PATCH \
  --url https://api.proxymail.qa/v1/project \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "website": "example", "environments": [ "example" ], "email_prefix": "example", "mail_domain": "example" }'

Changes the key’s project: its name, website, environments, email prefix or default mail domain, as in Project settings. Only the fields given change. It needs the project’s lead (or an organisation owner or admin), the same as in the app, and each change is in the project’s activity log. Archiving, deleting and keeping whole emails stay in the app.

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

>= 1 properties

name

string

<= 80 characters

website

The app under test, such as https://staging.example.com; empty or null to remove it.

string | null

<= 300 characters

environments

Such as [“staging”, “local”].

Array<string>

<= 10 items

email_prefix

Letters or digits new addresses start with; empty or null to remove it.

string | null

<= 12 characters

mail_domain

One of the mail domains GET /v1/project lists.

string

Example ^generated

{
  "name": "example",
  "website": "example",
  "environments": [
    "example"
  ],
  "email_prefix": "example",
  "mail_domain": "example"
}

Responses

200

The project, as GET /v1/project returns it

Media typeapplication/json

object

Example ^generated

{}

400

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

401

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}