API-reference for abonnenter

Hent abonnenter

Endpoint:

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

• Standardsidenummeret er 1.
• Standardværdien for per_page er 50, og der er højst 100 elementer pr. side.
• Den valgfrie søgeforespørgsel bruges til at filtrere abonnenter efter e-mailadresse eller telefonnummer.
• Den valgfrie status filtrerer abonnenter efter deres abonnementsstatus. Brug status=confirmed for at udelade alle, der endnu ikke har bekræftet.

Værdi	Returnerede abonnenter
confirmed	Bekræftede abonnenter, der modtager notifikationer.
unconfirmed	Godkendte abonnenter, der endnu ikke har bekræftet deres abonnement.
unapproved	Abonnenter, der afventer godkendelse, f.eks. importerede lister.

Eksempel på svar

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

Tilføj en abonnent

Endpoint:

POST /v1/:page_id/subscribers

Når nogen abonnerer, følger bekræftelsesforløbet sidens indstilling subscriberConfirmationMode. Brug autoConfirm på dette endpoint for at tilsidesætte det for en enkelt abonnent.

Eksempel på forespørgsel

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

• autoConfirm — valgfri. Når den er true, tilføjes abonnenten med det samme uden bekræftelses- eller velkomstmails, uanset sidens indstilling. Kun Pro.

Eksempel på svar

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

Eksempel på forespørgsel

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

Eksempel på svar

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

Tilføj flere abonnenter

Endpoint:

POST /v1/:page_id/subscribers/bulk

Med dette endpoint kan du oprette flere abonnenter i én forespørgsel.

Eksempel på forespørgsel

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

• autoConfirm gælder for alle abonnenter i partiet. Kun Pro.

Eksempel på svar

{
  "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 nogle abonnenter fejler

Hvis nogle abonnenter ikke kan oprettes (f.eks. dublet-e-mail eller forkert format), indeholder svaret detaljer om fejlene:

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

Bemærk:

• Højst 100 abonnenter pr. forespørgsel
• Hvert abonnentobjekt kan have de samme felter som endpointet for en enkelt abonnent
• Delvis succes understøttes — de abonnenter, der blev oprettet, returneres, selvom nogle fejler

Bekræftelsesforløb

Statussider styrer, hvordan nye abonnenter håndteres, via subscriberConfirmationMode på endpointet Opdater en statusside:

Værdi	Adfærd
REQUIRED	Abonnenter skal bekræfte via e-mail, før de modtager opdateringer. Standard.
WELCOME	Abonnenter tilføjes med det samme og modtager en velkomstmail. Kun Pro.
NONE	Abonnenter tilføjes med det samme uden nogen e-mail. Kun Pro.

Parameteren autoConfirm på opret-endpoints tilsidesætter sidens indstilling for den pågældende forespørgsel og opfører sig som NONE.

Fjern en abonnent

Endpoint:

DELETE /v1/:page_id/subscribers/:subscriber_id

Eksempel på svar

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