Minutemailer API

Använd Minutemailer API:et för att skapa, uppdatera och ta bort listor och kontakter från din app.

För att använda API:et behöver du en API token. Starta ett gratiskonto på Minutemailer och gå till dina API inställningar och skapa en token.

Du kan också använda våra färdiga bibliotek för att implementera API:et snabbt och enkelt. Just nu tillgängligt för PHP. Mer kommer snart.

API:et nås på api.minutemailer.com/v1

Översikt

Funktion HTTP metod Endpoint
Hämta alla kontaktlistor GET /contactlists
Skapa kontaktlista POST /contactlists
Hämta en lista GET /contactlists/{_id}
Uppdatera en kontaktlista PUT /contactlists/{_id}
Ta bort en kontaktlista DELETE /contactlists/{_id}
Lägg till en prenumerant till en lista POST /contactlists/{_id}/subscribe
Avregistrera en eller flera kontakter POST /contactlists/{_id}/unsubscribe/{_contact-id}
Hämta alla kontakter från en lista GET /contactlists/{_id}/contacts

Exempel

Din API token (bearer) måste ingå i alla förfrågningar via en auktoriserings-header. En enkel förfrågan kan se ut så här:

curl -i -H “Accept: application/json” -H “Authorization: Bearer {token}” https://api.minutemailer.com/v1/contactlists

Felhantering

Lämpliga felkoder returneras med alla förfrågningar tillsammans med ett meddelande, om det finns. Genomförda förfrågningar svarar med en 2xx statuskod tillsammans med ett JSON meddelande som beroende på endpoint (se exempel nedan).

Hämta alla kontaktlistor

Endpoint

GET /contactlists

Parametrar

Namn Typ Beskrivning Ursprungsvärde
take heltal Antal listor att returnera 10
skip heltal Antal listor från början som ska hoppas över 0
order sträng Kolumn att sortera efter. Kan vara created_at, updated_at eller name created_at
direction sträng Riktning att sortera efter, desc eller asc desc

Svar

{
  "contact_lists": [
    {
      "_id": "string",
      "name": "string",
      "created_at": "string",              
      "updated_at": "string",
      "status": "integer"
    }
  ],
  "num_rows": "integer"
}

Skapa kontaktlista

Endpoint

POST /contactlists

Argument

Namn Typ Obligatorisk
name sträng Ja

Svar

{
  "_id": "string",
  "name": "string",
  "created_at": "string",
  "updated_at": "string",
  "status": "integer"
}

Hämta en lista

Endpoint

GET /contactlists/{_id}

Svar

{
  "_id": "string",
  "name": "string",
  "created_at": "string",
  "updated_at": "string",
  "status": "integer"
}

Uppdatera en kontaktlista

Endpoint

PUT /contactlists/{_id}

Argument

Namn Typ Obligatorisk
name sträng Ja

Svar

{
  "message": "string"
}

Ta bort en kontaktlista

Endpoint

DELETE /contactlists/{_id}

Svar

{
  "message": "string"
}

Lägg till en prenumerant till en lista

Endpoint

POST /contactlists/{_id}/subscribe

Argument

Namn Typ Obligatorisk
name sträng Nej
email sträng Ja

Svar

{
  "message": "string"
}

Avregistrera en eller flera kontakter

Endpoint

POST /contactlists/{_id}/unsubcribe/{_contact-id}

Svar

{
  "message": "string"
}

Hämta alla kontakter från en lista

Endpoint

GET /contactlists/{_id}/contacts

Parametrar

Namn Typ Beskrivning Ursprungsvärde
take heltal Antal listor att returnera 10
skip heltal Antal listor från början som ska hoppas över 0
order sträng Kolumn att sortera efter. Kan vara created_at, updated_at, email eller name created_at
direction sträng Riktning att sortera efter, desc eller asc desc
status sträng Kan vara antingen subscriber eller unsubscribed. Ta inte med för att inkludera alla typer av kontakter.

Svar

{
  "contacts": [
    {
      "_id": "string",
      "name": "string",
      "email": "string",
      "origin": "integer",
      "status": "integer",
      "uninteracted_emails": "integer",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "num_rows": "integer"
}

Om du letar efter fler sätt att integrera med Minutemailer hittar du det på vår sida för utvecklare.

Guider & tips

Starta gratiskonto