Reference API pro odběratele

Získání odběratelů

Endpoint:

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

• Výchozí číslo stránky je 1.
• Výchozí hodnota per_page je 50, maximum je 100 položek na stránku.
• Nepovinný vyhledávací dotaz filtruje odběratele podle e-mailové adresy nebo telefonního čísla.

Ukázková odpověď

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

Přidání odběratele

Endpoint:

POST /v1/:page_id/subscribers

Když se někdo přihlásí k odběru, řídí se potvrzování nastavením subscriberConfirmationMode dané stránky. Parametrem autoConfirm na tomto endpointu toto chování pro jednoho odběratele přepíšete.

Ukázkový požadavek

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

• autoConfirm — nepovinné. Když je true, přidá odběratele okamžitě bez potvrzovacího ani uvítacího e-mailu, bez ohledu na nastavení stránky. Jen v tarifu Pro.

Ukázková odpověď

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

Odběr jen určitých komponent

Ukázkový požadavek

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

Ukázková odpověď

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

Přidání více odběratelů

Endpoint:

POST /v1/:page_id/subscribers/bulk

Tímto endpointem vytvoříte více odběratelů jedním požadavkem.

Ukázkový požadavek

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

• autoConfirm platí pro každého odběratele v dávce. Jen v tarifu Pro.

Ukázková odpověď

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

Odpověď, když se někteří odběratelé nepodaří přidat

Pokud se některé odběratele nepodaří vytvořit (třeba duplicitní e-mail nebo špatný formát), odpověď bude obsahovat podrobnosti o chybách:

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

Poznámky:

• Maximálně 100 odběratelů na požadavek
• Každý objekt odběratele může mít stejná pole jako endpoint pro jednoho odběratele
• Podporovaný je i částečný úspěch – úspěšně vytvoření odběratelé se vrátí, i když některé vytvořit nešlo

Chování při potvrzování

Stavové stránky řídí zacházení s novými odběrateli přes subscriberConfirmationMode na endpointu Aktualizace stavové stránky:

Hodnota	Chování
REQUIRED	Odběratelé musí odběr potvrdit e-mailem, než jim začnou chodit aktualizace. Výchozí.
WELCOME	Odběratelé se přidají okamžitě a dostanou uvítací e-mail. Jen v tarifu Pro.
NONE	Odběratelé se přidají okamžitě bez e-mailu. Jen v tarifu Pro.

Parametr autoConfirm na endpointech pro vytvoření přepíše pro daný požadavek nastavení stránky a chová se jako NONE.

Odebrání odběratele

Endpoint:

DELETE /v1/:page_id/subscribers/:subscriber_id

Ukázková odpověď

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