---
title: "Turn a custom field on or off | Proxy Mail QA"
description: "Developer docs for Proxy Mail QA: the MCP server for coding agents, the REST API for test suites, and the Chrome extension."
url: https://proxymail.qa/docs/reference/operations/setcustomfieldenabled
---

# Turn a custom field on or off

PATCH

/v1/project/custom-fields

```js
const url = 'https://api.proxymail.qa/v1/project/custom-fields';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","enabled":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```sh
curl --request PATCH \
  --url https://api.proxymail.qa/v1/project/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "enabled": true }'
```

Turns it on or off, as its switch in Project settings → Custom fields does. When it’s off, form-values and Proxy Mail QA for Chrome 0.9.0 and later ignore it, as if it weren’t there: the field gets the next custom field that’s on, then a standard value, then a guess if the project’s guesses setting allows one. To keep a field empty, give a custom field the value `leave` instead. One that’s off is still listed, and still counts toward the 50\. On a locked project, a key whose creator isn’t a lead asks the leads instead (202, `status: "requested"`).

## Authorizations

- **[apiKey](https://proxymail.qa/docs/reference.html#apikey)**
- **[apiKeyHeader](https://proxymail.qa/docs/reference.html#apikeyheader)**

## Request Bodyrequired

Media typeapplication/json

### object

**id**

required

The custom field to turn on or off.

string format: uuid

<= 36 characters

**enabled**

required

True to use it; false to ignore it.

boolean

### Example generated

```json
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "enabled": true
}
```

## Responses

### 200

Changed

Media typeapplication/json

### object

**status**

Requested: the project is locked, so a lead was asked.

string

Allowed values: saved removed requested

**field**

A custom field: what it recognises, where and what goes in it. Who made it, and when, are in the app.

### object

**id**

required

string format: uuid

**name**

required

string

**enabled**

required

False when fills ignore it, as if it weren’t there. It still counts toward the 50.

boolean

**match**

required

### object

**on**

Kind: a ready-made custom field, text its section.

string

Allowed values: words test\_id name html\_id kind

**text**

string

**also**

Words only, when it has more phrases.

Array<string>

**site**

required

The site pattern it applies on, or null for every site.

string | null

**path**

required

The page path it applies on, or null for every page.

string | null

**field\_type**

required

string | null

Allowed values: text textarea number select checkbox radio

**value**

required

What goes in the field. text: { text }. template: { template } with {first\_name}, {last\_name}, {full\_name}, {username}, {email}, {company}, {country} or {digits:N} (N from 1 to 12). option: { option }, the option to pick. list: { items }, 2 to 20, one picked for each account. options: { options }, 1 to 20, every one for every account: ticks the boxes of a group (matched by their shared name or words in the question they answer) or selects them in a drop-down that takes several answers, and boxes not listed are unticked, though a consent box, a marketing box or a box with its own custom field is left as it is. Never a radio group. checkbox: { checked }. generate: Proxy Mail QA makes up a value that suits the field (the same for the same account), on any field but a checkbox, never a personal ID field. leave: leave the field as it is. ready\_made: { section }, matched on kind (or test\_id when a sign-up form made it), Proxy Mail QA’s own safe value, where it has one: phone (a number set aside for fiction, or `phones`: the team’s own test number per country), id.national, id.tax, id.passport, business.vat and business.tax (a fake value only where one can never be a real person’s, or `ids_from`: a KYC vendor’s sandbox values), gender, referral\_source, language, business.role, business.team\_size and business.type (one of the field’s options) and consent.terms (ticked unless `checked` is false).

### object

**kind**

required

string

Allowed values: text template option list options checkbox generate leave ready\_made

**text**

string

<= 200 characters

**template**

string

<= 200 characters

**option**

string

<= 100 characters

**items**

Array<string>

\>= 2 items <= 20 items

**options**

Array<string>

\>= 1 items <= 20 items

**checked**

Checkbox, or ready\_made consent.terms (true by default).

boolean

**section**

Ready\_made only: the field catalogue section it fills.

string

Allowed values: phone id.national id.tax id.passport business.vat business.tax gender referral\_source language business.role business.team\_size business.type consent.terms

**ids\_from**

Ready\_made ID and tax numbers only: safe (the default) or a KYC vendor’s sandbox values.

string

Allowed values: safe stripe plaid onfido veriff didit cashfree setu

**phones**

Ready\_made phone only: the team’s own test numbers, one per country, for accounts in countries with no numbers set aside for fiction. Never a real person’s number.

Array<object>

<= 20 items

### object

**country**

required

string

/^\[A-Za-z\]{2}$/

**number**

required

4 to 30 digits, spaces, brackets or dashes, with an optional leading +.

string

<= 30 characters

**tag\_answer**

required

boolean

**id**

The custom field removed.

string format: uuid

**request**

A request to the project’s leads, who approve or decline it in Project settings. Who asked and answered, and when, are in the app.

### object

**id**

required

string format: uuid

**kind**

required

string

Allowed values: save\_custom\_field delete\_custom\_field add\_site remove\_site set\_guesses set\_multi\_step save\_signup\_screen remove\_signup\_screen set\_custom\_field\_enabled set\_standard\_field save\_signup\_form

**target\_id**

required

The custom field, site, sign-up screen or sign-up form it changes, if any.

string | null format: uuid

**summary**

required

The custom field’s name, the site, the screen, or the setting’s new choice.

string

**change**

required

What it changes, as it applies once a lead approves it.

### object

**note**

required

What the person who asked wrote for the leads.

string | null

**status**

required

string

Allowed values: requested approved declined withdrawn expired unlocked

**reason**

required

A lead’s reason for declining.

string | null

#### Example 

```json
{
  "status": "saved",
  "field": {
    "match": {
      "on": "words"
    },
    "field_type": "text",
    "value": {
      "kind": "text",
      "section": "phone",
      "ids_from": "safe",
      "phones": [
        {
          "country": "IN"
        }
      ]
    }
  },
  "request": {
    "kind": "save_custom_field",
    "status": "requested"
  }
}
```

### 202

Asked a lead

Media typeapplication/json

### object

**status**

Requested: the project is locked, so a lead was asked.

string

Allowed values: saved removed requested

**field**

A custom field: what it recognises, where and what goes in it. Who made it, and when, are in the app.

### object

**id**

required

string format: uuid

**name**

required

string

**enabled**

required

False when fills ignore it, as if it weren’t there. It still counts toward the 50.

boolean

**match**

required

### object

**on**

Kind: a ready-made custom field, text its section.

string

Allowed values: words test\_id name html\_id kind

**text**

string

**also**

Words only, when it has more phrases.

Array<string>

**site**

required

The site pattern it applies on, or null for every site.

string | null

**path**

required

The page path it applies on, or null for every page.

string | null

**field\_type**

required

string | null

Allowed values: text textarea number select checkbox radio

**value**

required

What goes in the field. text: { text }. template: { template } with {first\_name}, {last\_name}, {full\_name}, {username}, {email}, {company}, {country} or {digits:N} (N from 1 to 12). option: { option }, the option to pick. list: { items }, 2 to 20, one picked for each account. options: { options }, 1 to 20, every one for every account: ticks the boxes of a group (matched by their shared name or words in the question they answer) or selects them in a drop-down that takes several answers, and boxes not listed are unticked, though a consent box, a marketing box or a box with its own custom field is left as it is. Never a radio group. checkbox: { checked }. generate: Proxy Mail QA makes up a value that suits the field (the same for the same account), on any field but a checkbox, never a personal ID field. leave: leave the field as it is. ready\_made: { section }, matched on kind (or test\_id when a sign-up form made it), Proxy Mail QA’s own safe value, where it has one: phone (a number set aside for fiction, or `phones`: the team’s own test number per country), id.national, id.tax, id.passport, business.vat and business.tax (a fake value only where one can never be a real person’s, or `ids_from`: a KYC vendor’s sandbox values), gender, referral\_source, language, business.role, business.team\_size and business.type (one of the field’s options) and consent.terms (ticked unless `checked` is false).

### object

**kind**

required

string

Allowed values: text template option list options checkbox generate leave ready\_made

**text**

string

<= 200 characters

**template**

string

<= 200 characters

**option**

string

<= 100 characters

**items**

Array<string>

\>= 2 items <= 20 items

**options**

Array<string>

\>= 1 items <= 20 items

**checked**

Checkbox, or ready\_made consent.terms (true by default).

boolean

**section**

Ready\_made only: the field catalogue section it fills.

string

Allowed values: phone id.national id.tax id.passport business.vat business.tax gender referral\_source language business.role business.team\_size business.type consent.terms

**ids\_from**

Ready\_made ID and tax numbers only: safe (the default) or a KYC vendor’s sandbox values.

string

Allowed values: safe stripe plaid onfido veriff didit cashfree setu

**phones**

Ready\_made phone only: the team’s own test numbers, one per country, for accounts in countries with no numbers set aside for fiction. Never a real person’s number.

Array<object>

<= 20 items

### object

**country**

required

string

/^\[A-Za-z\]{2}$/

**number**

required

4 to 30 digits, spaces, brackets or dashes, with an optional leading +.

string

<= 30 characters

**tag\_answer**

required

boolean

**id**

The custom field removed.

string format: uuid

**request**

A request to the project’s leads, who approve or decline it in Project settings. Who asked and answered, and when, are in the app.

### object

**id**

required

string format: uuid

**kind**

required

string

Allowed values: save\_custom\_field delete\_custom\_field add\_site remove\_site set\_guesses set\_multi\_step save\_signup\_screen remove\_signup\_screen set\_custom\_field\_enabled set\_standard\_field save\_signup\_form

**target\_id**

required

The custom field, site, sign-up screen or sign-up form it changes, if any.

string | null format: uuid

**summary**

required

The custom field’s name, the site, the screen, or the setting’s new choice.

string

**change**

required

What it changes, as it applies once a lead approves it.

### object

**note**

required

What the person who asked wrote for the leads.

string | null

**status**

required

string

Allowed values: requested approved declined withdrawn expired unlocked

**reason**

required

A lead’s reason for declining.

string | null

#### Example 

```json
{
  "status": "saved",
  "field": {
    "match": {
      "on": "words"
    },
    "field_type": "text",
    "value": {
      "kind": "text",
      "section": "phone",
      "ids_from": "safe",
      "phones": [
        {
          "country": "IN"
        }
      ]
    }
  },
  "request": {
    "kind": "save_custom_field",
    "status": "requested"
  }
}
```

### 400

An error

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

### 401

No API key, or one that isn’t valid: it may have been revoked, or its creator no longer has access to the project.

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

#### Headers

**WWW-Authenticate**

string

`Bearer realm="proxymail-qa"`, with `error="invalid_token"` when a key was sent but isn’t valid.

### 403

An error

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

### 404

An error

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

### 405

The path doesn’t take this method.

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

#### Headers

**Allow**

string

The methods it takes, such as `GET, PATCH`.

### 409

An error

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

### 413

The request body is over 64 KB, or 256 KB for POST /v1/form-values.

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

### 429

Too many requests. With a Retry-After header, a per-minute limit was reached: the key’s requests (60 a minute on Free, 600 on Team), password reveals (30 a minute per person), or keys that aren’t valid from one network (120 a minute). Without one, `error` says which longer limit: `daily_limit`, the space’s new addresses for today (50 on Free), until midnight UTC; `account_held`, 10 addresses a day while a Free account’s recent use is looked at; or `rate_limited` when something is full, such as a project’s 50 custom fields.

Media typeapplication/json

### object

**error**

What went wrong, as a code, such as bad\_request (400), unauthorized (401), plan\_required (402), forbidden (403), not\_found (404), method\_not\_allowed (405), conflict (409), content\_too\_large (413), rate\_limited, daily\_limit or account\_held (429), or server\_error (500).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

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

#### Headers

**Retry-After**

integer

\>= 1

Seconds to wait before trying again. Sent with per-minute limits only.

[Previous](https://proxymail.qa/docs/reference/operations/savecustomfield.html): Add or change a custom field

[Next](https://proxymail.qa/docs/reference/operations/setstandardfield.html): Turn a standard field on or off
