# API-referanse for abonnenter

Source: https://instatus.com/help/no/api/subscribers

## Hent abonnenter

**Endepunkt:**

```bash
GET /v2/:page_id/subscribers?page=:page&per_page=:per_page&search=:search_query&status=:status
```

- Standard sidenummer er 1.
- Standardverdien for per_page er 50, og maksimum er 100 elementer per side.
- En valgfri søkespørring brukes til å filtrere abonnenter etter e-postadresse eller telefonnummer.
- Valgfri `status` filtrerer abonnenter etter abonnementsstatus. Bruk `status=confirmed` for å utelate alle som ennå ikke har bekreftet.

| Verdi | Abonnenter som returneres |
| --- | --- |
| `confirmed` | Bekreftede abonnenter som mottar varsler. |
| `unconfirmed` | Godkjente abonnenter som ennå ikke har bekreftet abonnementet sitt. |
| `unapproved` | Abonnenter som venter på godkjenning, for eksempel importerte lister. |

**Eksempelsvar**

```json
[
  {
    "id": "cm1111x6ofgsd5666mzxcw978qh",
    "email": "ali@instatus.com",
    "phone": null,
    "webhook": null,
    "webhookEmail": null,
    "confirmed": false,
    "approved": true,
    "all": true,
    "components": []
  },
  {
    "id": "cm1111x6ofgsd5666mzxcw978qh",
    "email": null,
    "phone": "5417543010",
    "webhook": null,
    "webhookEmail": null,
    "confirmed": false,
    "approved": true,
    "all": true,
    "components": []
  }
]
```

## Legg til en abonnent

**Endepunkt:**

```bash
POST /v1/:page_id/subscribers
```

Når noen abonnerer, følger bekreftelsesatferden sidens innstilling for `subscriberConfirmationMode`. Bruk `autoConfirm` på dette endepunktet for å overstyre atferden for én enkelt abonnent.

**Eksempelforespørsel**

```json
{
  "email": "sarah@instatus.com",
  "all": true,
  "autoConfirm": false
}
```

- `autoConfirm` — valgfritt. Når den er `true`, legges abonnenten til umiddelbart uten at det sendes bekreftelses- eller velkomst-e-post, uavhengig av innstillingen på siden. Kun Pro.

**Eksempelsvar**

```json
{
  "id": "cm1111x6ofgsd5666mzxcw978df",
  "name": null,
  "email": "sarahs@instatus.com",
  "phone": null,
  "confirmed": false,
  "all": true,
  "createdAt": "2024-10-01T03:48:41.474Z",
  "updatedAt": "2024-10-01T03:48:41.474Z",
  "siteId": "cm1111x6ofgsd5666mzxcw978qh",
  "unsubscribeToken": "e3b51de6-1234-4664-zxyv-1679gg524260",
  "webhook": null,
  "webhookEmail": null,
  "discord": null,
  "discordTeam": null,
  "slack": null,
  "slackTeam": null,
  "language": "en",
  "company": null,
  "microsoftTeamsWebhook": null,
  "googleChatWebhook": null,
  "googleChatSpace": null,
  "failedAttempts": 0,
  "approved": true,
  "importedFrom": null,
  "hideUnsubLink": false,
  "webhookIncidentBody": null,
  "webhookMaintenanceBody": null,
  "webhookComponentBody": null,
  "webhookHttpMethod": "POST",
  "webhookHeaders": null,
  "site": {
    "id": "cm1111x6ofgsd5666mzxcw978qh"
  }
}
```

### Abonner på bestemte komponenter

**Eksempelforespørsel**

```json
{
  "email": "adam@instatus.com",
  "all": false,
  "components": ["cl2xv23rl0119e7jlk2mweepd"],
  "autoConfirm": false
}
```

**Eksempelsvar**

```json
{
  "id": "cl09gt11151422bjluflghewx",
  "email": "adam@instatus.com",
  "site": {
    "id": "ckg8a112344s5v86wrn",
    "name": "Test",
    "logoUrl": null,
    "subdomain": "test",
    "publicEmail": null,
    "language": "en"
  }
}
```

## Legg til flere abonnenter

**Endepunkt:**

```bash
POST /v1/:page_id/subscribers/bulk
```

Med dette endepunktet kan du opprette flere abonnenter i én enkelt forespørsel.

**Eksempelforespørsel**

```json
{
  "subscribers": [
    {
      "email": "sarah@instatus.com",
      "all": true
    },
    {
      "email": "john@instatus.com",
      "components": ["cl2xv23rl0119e7jlk2mweepd"]
    },
    {
      "name": "Jane Doe",
      "phone": "5417543010",
      "all": true
    }
  ],
  "autoConfirm": false
}
```

- `autoConfirm` gjelder for alle abonnentene i batchen. Kun Pro.

**Eksempelsvar**

```json
{
  "success": true,
  "created": 3,
  "failed": 0,
  "results": {
    "created": [
      {
        "id": "cm1111x6ofgsd5666mzxcw978df",
        "email": "sarah@instatus.com",
        "phone": null,
        "confirmed": false,
        "all": true,
        "site": {
          "id": "cm1111x6ofgsd5666mzxcw978qh"
        }
      },
      {
        "id": "cm2222x6ofgsd5666mzxcw978df",
        "email": "john@instatus.com",
        "phone": null,
        "confirmed": false,
        "all": false,
        "site": {
          "id": "cm1111x6ofgsd5666mzxcw978qh"
        }
      },
      {
        "id": "cm3333x6ofgsd5666mzxcw978df",
        "email": null,
        "phone": "5417543010",
        "name": "Jane Doe",
        "confirmed": false,
        "all": true,
        "site": {
          "id": "cm1111x6ofgsd5666mzxcw978qh"
        }
      }
    ],
    "failed": []
  }
}
```

**Svar når noen abonnenter feiler**

Hvis noen abonnenter ikke kan opprettes (for eksempel duplikat e-post eller feil format), inneholder svaret detaljer om feilene:

```json
{
  "success": false,
  "created": 2,
  "failed": 1,
  "results": {
    "created": [
      {
        "id": "cm1111x6ofgsd5666mzxcw978df",
        "email": "sarah@instatus.com",
        "site": {
          "id": "cm1111x6ofgsd5666mzxcw978qh"
        }
      },
      {
        "id": "cm2222x6ofgsd5666mzxcw978df",
        "email": "john@instatus.com",
        "site": {
          "id": "cm1111x6ofgsd5666mzxcw978qh"
        }
      }
    ],
    "failed": [
      {
        "index": 2,
        "subscriber": {
          "email": "duplicate@instatus.com",
          "all": true
        },
        "error": {
          "code": "creation_failed",
          "message": "Subscriber with this email already exists"
        }
      }
    ]
  }
}
```

**Merknader:**

- Maksimalt 100 abonnenter per forespørsel
- Hvert abonnentobjekt kan ha de samme feltene som endepunktet for én enkelt abonnent
- Delvis suksess støttes – abonnenter som ble opprettet, returneres selv om noen feiler

## Bekreftelsesatferd

Statussider styrer hvordan nye abonnenter håndteres, via `subscriberConfirmationMode` på endepunktet [Oppdater en statusside](https://instatus.com/help/no/api/status-pages):

| Verdi | Atferd |
| --- | --- |
| `REQUIRED` | Abonnenter må bekrefte via e-post før de mottar oppdateringer. Standard. |
| `WELCOME` | Abonnenter legges til umiddelbart og får en velkomst-e-post. Kun Pro. |
| `NONE` | Abonnenter legges til umiddelbart uten e-post. Kun Pro. |

Parameteren `autoConfirm` på opprettelsesendepunktene overstyrer sidens innstilling for den forespørselen og oppfører seg som `NONE`.

## Fjern en abonnent

**Endepunkt:**

```bash
DELETE /v1/:page_id/subscribers/:subscriber_id
```

**Eksempelsvar**

```json
{
  "id": "cm1zvzm3434dlp9255d6jgy8",
  "name": null,
  "email": "sarah@instatus.com",
  "phone": null,
  "webhook": null,
  "webhookEmail": null,
  "discord": null,
  "microsoftTeamsWebhook": null,
  "company": null,
  "site": {
    "id": "cm180slpo000g9343478qh"
  }
}
```