API-referens för prenumeranter

Hämta prenumeranter

Endpoint:

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

• Standardvärdet för page är 1.
• Standardvärdet för per_page är 50 och maxvärdet är 100 poster per sida.
• Den valfria sökfrågan används för att filtrera prenumeranter på e-postadress eller telefonnummer.
• Den valfria parametern status filtrerar prenumeranter på prenumerationsstatus. Använd status=confirmed för att utesluta alla som inte har bekräftat ännu.

Värde	Prenumeranter som returneras
confirmed	Bekräftade prenumeranter som får aviseringar.
unconfirmed	Godkända prenumeranter som inte har bekräftat sin prenumeration ännu.
unapproved	Prenumeranter som väntar på godkännande, till exempel importerade listor.

Exempelsvar

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

Lägg till en prenumerant

Endpoint:

POST /v1/:page_id/subscribers

När någon prenumererar följer bekräftelsebeteendet sidans inställning subscriberConfirmationMode. Använd autoConfirm på den här endpointen för att åsidosätta beteendet för en enskild prenumerant.

Exempelanrop

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

• autoConfirm — valfritt. När den är true läggs prenumeranten till direkt utan bekräftelse- eller välkomstmejl, oavsett sidans inställning. Endast Pro.

Exempelsvar

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

Prenumerera på specifika komponenter

Exempelanrop

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

Exempelsvar

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

Lägg till flera prenumeranter

Endpoint:

POST /v1/:page_id/subscribers/bulk

Med den här endpointen kan du skapa flera prenumeranter i ett och samma anrop.

Exempelanrop

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

• autoConfirm gäller alla prenumeranter i batchen. Endast Pro.

Exempelsvar

{
  "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 vissa prenumeranter misslyckas

Om vissa prenumeranter inte kan skapas (t.ex. dubblerad e-postadress eller fel format) innehåller svaret detaljer om felen:

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

Att tänka på:

• Högst 100 prenumeranter per anrop
• Varje prenumerantobjekt kan ha samma fält som endpointen för en enskild prenumerant
• Delvis lyckade anrop stöds – prenumeranter som skapats returneras även om några misslyckas

Bekräftelsebeteende

Statussidor styr hur nya prenumeranter hanteras via subscriberConfirmationMode på endpointen Uppdatera en statussida:

Värde	Beteende
REQUIRED	Prenumeranter måste bekräfta via e-post innan de får uppdateringar. Standard.
WELCOME	Prenumeranter läggs till direkt och får ett välkomstmejl. Endast Pro.
NONE	Prenumeranter läggs till direkt utan något mejl. Endast Pro.

Parametern autoConfirm på skapa-endpointerna åsidosätter sidans inställning för det anropet och beter sig som NONE.

Ta bort en prenumerant

Endpoint:

DELETE /v1/:page_id/subscribers/:subscriber_id

Exempelsvar

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