# Tilaajien API-referenssi

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

## Hae tilaajat

**Päätepiste:**

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

- Oletussivunumero on 1.
- Oletusarvo per_page on 50 ja enimmäismäärä on 100 kohdetta sivua kohden.
- Valinnaisella hakukyselyllä voit suodattaa tilaajia sähköpostiosoitteen tai puhelinnumeron perusteella.
- Valinnainen `status` suodattaa tilaajat tilauksen tilan perusteella. Käytä arvoa `status=confirmed` jättääksesi pois kaikki, jotka eivät ole vielä vahvistaneet tilaustaan.

| Arvo | Palautettavat tilaajat |
| --- | --- |
| `confirmed` | Vahvistetut tilaajat, jotka saavat ilmoituksia. |
| `unconfirmed` | Hyväksytyt tilaajat, jotka eivät ole vielä vahvistaneet tilaustaan. |
| `unapproved` | Hyväksyntää odottavat tilaajat, kuten tuodut listat. |

**Esimerkkivastaus**

```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": []
  }
]
```

## Lisää tilaaja

**Päätepiste:**

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

Kun joku tilaa päivitykset, vahvistuksen toiminta noudattaa sivun `subscriberConfirmationMode`-asetusta. Käytä tämän päätepisteen `autoConfirm`-parametria ohittaaksesi tuon toiminnan yksittäisen tilaajan kohdalla.

**Esimerkkipyyntö**

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

- `autoConfirm` — valinnainen. Kun arvo on `true`, tilaaja lisätään heti ilman vahvistus- tai tervetuloviestejä sivun asetuksesta riippumatta. Vain Pro.

**Esimerkkivastaus**

```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"
  }
}
```

### Tilaa tietyt komponentit

**Esimerkkipyyntö**

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

**Esimerkkivastaus**

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

## Lisää useita tilaajia

**Päätepiste:**

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

Tämän päätepisteen avulla voit luoda useita tilaajia yhdellä pyynnöllä.

**Esimerkkipyyntö**

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

- `autoConfirm` koskee jokaista erän tilaajaa. Vain Pro.

**Esimerkkivastaus**

```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": []
  }
}
```

**Vastaus, kun osan tilaajista luonti epäonnistuu**

Jos joidenkin tilaajien luonti epäonnistuu (esim. kaksoiskappale sähköpostista tai virheellinen muoto), vastaus sisältää tiedot epäonnistumisista:

```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"
        }
      }
    ]
  }
}
```

**Huomioita:**

- Enintään 100 tilaajaa pyyntöä kohden
- Jokaisella tilaajaobjektilla voi olla samat kentät kuin yksittäisen tilaajan päätepisteessä
- Osittainen onnistuminen on tuettu – onnistuneesti luodut tilaajat palautetaan, vaikka osa epäonnistuisi

## Vahvistuksen toiminta

Statussivut ohjaavat uusien tilaajien käsittelyä `subscriberConfirmationMode`-asetuksella [Päivitä statussivu](https://instatus.com/help/fi/api/status-pages) -päätepisteessä:

| Arvo | Toiminta |
| --- | --- |
| `REQUIRED` | Tilaajien on vahvistettava tilaus sähköpostitse ennen päivitysten saamista. Oletus. |
| `WELCOME` | Tilaajat lisätään heti ja he saavat tervetuloviestin. Vain Pro. |
| `NONE` | Tilaajat lisätään heti ilman sähköpostia. Vain Pro. |

Luontipäätepisteiden `autoConfirm`-parametri ohittaa sivun asetuksen kyseisen pyynnön osalta ja toimii kuten `NONE`.

## Poista tilaaja

**Päätepiste:**

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

**Esimerkkivastaus**

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