## Define a contact field

`PUT https://whatsapp.paaltech.org/api/v1/businesses/{external_id}/contact-fields/{key}`

Create a custom contact field for the business, or change its label, type or choices.

Ability: `contacts.write`

### Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `external_id` | string | yes | Your own ID for the business (Multi-SKUUL - the tenant ID). Max 191 characters. Pattern `^[A-Za-z0-9._:-]+$` |
| `key` | string | yes | Max 64 characters. Pattern `^[a-z][a-z0-9_]*$` |

### Body

| Name | Type | Required | Description |
|---|---|---|---|
| `label` | string | yes | Max 191 characters |
| `type` | string | yes | One of: `text`, `number`, `date`, `boolean`, `choice` |
| `choices` | array of strings | null | no | Required for choice fields. |

### Request

```bash
curl --request PUT \
  --url 'https://whatsapp.paaltech.org/api/v1/businesses/presec/contact-fields/key' \
  --header "Authorization: Bearer $PAALCHAT_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"label": "Class", "type": "choice", "choices": ["SHS 1", "SHS 2", "SHS 3"]}'
```

### Responses

- **200** - Updated.
- **201** - Created.

```json
{
  "data": {
    "key": "class",
    "label": "Class",
    "type": "choice",
    "choices": ["SHS 1", "SHS 2", "SHS 3"]
  }
}
```

- **401** - unauthenticated - missing, invalid, revoked or expired token

```json
{
  "error": {"code": "unauthenticated", "message": "A valid product token is required."}
}
```

- **403** - missing_ability, product_suspended or product_token_required

```json
{
  "error": {
    "code": "missing_ability",
    "message": "This token does not have the ability this request needs."
  }
}
```

- **404** - not_found - not yours, or does not exist

```json
{"error": {"code": "not_found", "message": "Business not found."}}
```

- **422** - validation_failed - fields are invalid; see errors.

```json
{
  "error": {
    "code": "validation_failed",
    "message": "The external id field format is invalid. (and 1 more error)"
  },
  "errors": {
    "external_id": ["The external id field format is invalid."],
    "name": ["The name field is required."]
  }
}
```

- **429** - rate_limited - over 300 requests/minute for this product

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and retry after the Retry-After header."
  }
}
```