# Add a notification method

`POST https://evohub.io/api/v1/notification-preferences`

Part of the [On-Call API](https://docs-dev.evohub.io/oncall.md) reference · operationId `createNotificationPreference`.

Adds a way to notify the caller. `target` is a phone number in international
form (`+` and the country code) for `voice` and `sms`, an address for
`email`, and not needed for `push` (the caller's signed-in devices are used).
SMS may not be available. `enabled` defaults to true.

These are the caller's own, across every organization they belong to. Meant
for a person; with an organization API key the key itself is the caller.

**Permission:** none — any valid API key or signed-in member of the organization.

## Authorization

Any one of:

- `bearerAuth`
- `apiKeyHeader`

Where:

- `bearerAuth`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `apiKeyHeader`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Request body (required)

Content type: `application/json`

Type: `NotificationPreferenceCreate`

- `channel` (NotificationChannel, required, one of `push`, `voice`, `email`, `sms`)
- `target` (string)
- `priority` (integer)
- `enabled` (boolean, default `true`)
- `quiet_start` (string)
- `quiet_end` (string)

## Responses

### 201 — The preference.

Content type: `application/json`

Type: `object`

- `data` (NotificationPreference, required)
  - `id` (string)
  - `org_id` (string): The organization it was created from.
  - `user_id` (string)
  - `channel` (NotificationChannel, one of `push`, `voice`, `email`, `sms`)
  - `target` (string): Phone number, email address, or empty for push.
  - `priority` (integer): 0 is tried first.
  - `enabled` (boolean)
  - `quiet_start` (string): Stored for older clients; no longer used. Use the notification schedule.
  - `quiet_end` (string): Stored for older clients; no longer used.
  - `created_at` (string (date-time))
  - `updated_at` (string (date-time))
- `success` (boolean, required, value `true`)

### 400 — The body is not JSON (`INVALID_BODY`), or it was refused (`VALIDATION_ERROR`, the message says why): unknown channel, missing or malformed target, SMS unavailable, or the same channel and target already exist.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 429 — Too many requests (`RATE_LIMITED`). Wait `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.

## Example request

```bash
curl -X POST 'https://evohub.io/api/v1/notification-preferences' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "target": "+905321234567",
  "channel": "voice",
  "priority": 0
}'
```