Hopp til innhold
skribbskribb

Utviklere

Nyhetsbrev

Nyhetsbrev

Utseendet og stemmen i e-posten abonnentene får, slik den står under Nyhetsbrev i oversikten. Utseende-ruta svarer for bloggen, altså siden leseren kommer til når de følger lenka. Denne svarer for brevet som bar lenka. Aksentfargen og skriftene er felles og settes under Utseende. Tilgangene er egne: newsletter:read og newsletter:write endrer hvordan brevet ser ut, og sender ingenting. Det gjør newsletter:send.

Alle sidene

Kodeeksemplene kaller en skribb-funksjon du setter opp selv. Hent klienten for språket ditt og lim den inn én gang, så kan eksemplene under limes rett etter.

GET/v1/newsletter

newsletter:read

Hent oppsettet

Alle sju feltene, slik de står nå. Verdiene er de samme som skjemaet under Nyhetsbrev viser, og de gjelder både brevet som går ut når du publiserer, og e-poster du sender til abonnentene selv.

Svaret · 200

newsletterNewsletterSettings
Oppsettet.
Svar
{
  "newsletter": {
    "body_mode": "full",
    "audience": "all",
    "greeting": "God morgen,",
    "signoff": "Takk for at du leser.",
    "welcome": "Hyggelig å ha deg med.",
    "logo_url": "https://media.skribb.no/logo.png",
    "reply_to": "hei@dittnavn.no"
  }
}
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/newsletter"

PATCH/v1/newsletter

newsletter:write

Endre ett eller flere av dem

Send de feltene du vil endre. Resten står. Sender du ingen av dem, svarer vi 422 empty-update. Tom streng er en verdi som alle andre og er slik du fjerner en hilsen, en logo eller en svaradresse. En for lang tekst blir avvist, ikke kortet ned: en signatur kappet på midten går ut til hele lista og ser ut som en feil hos deg. Det nye oppsettet går ut til publikasjonen med en gang, og mirrored sier om det kom fram. Kom det ikke fram, er det lagret her, og neste lagring tar det med.

Bodyen du sender

body_modestring
Hvor mye av innlegget som følger med i e-posten. teaser er tittel, ingress og en lenke videre. full er hele teksten rett i innboksen. Betalt innhold sendes uansett bare som den gratis smakebiten.teaserfull
audiencestring
Hvem som får e-post når du publiserer et innlegg. all er alle bekreftede abonnenter, paid bare de betalende. Gjelder utsendingen som skjer av seg selv ved publisering.allpaid
greetingstring
Linja over innlegget, med dine egne ord. Inntil 140 tegn; er den lengre, avviser vi den heller enn å korte den ned.
signoffstring
Linja under innlegget. Står den tom, signerer vi med navnet på publikasjonen. Inntil 240 tegn; er den lengre, avviser vi den heller enn å korte den ned.
welcomestring
Hilsenen en ny abonnent får i velkomstbrevet. Inntil 600 tegn; er den lengre, avviser vi den heller enn å korte den ned.
logo_urlstring
Adressen til logoen øverst i e-posten. Tom streng fjerner den, og da faller vi tilbake på logoen bloggen bruker. Topptekst med logo vises bare med Skribb Mer; uten den lagres adressen, men e-posten viser navnet på publikasjonen i stedet. Inntil 500 tegn; er den lengre, avviser vi den heller enn å korte den ned.
reply_tostring
Adressen et svar på nyhetsbrevet går til. Tom streng skrur av svar. Krever Skribb Mer: uten den svarer ruta 409 premium-plan-required i stedet for å lagre stille. Inntil 254 tegn; er den lengre, avviser vi den heller enn å korte den ned.

Svaret · 200

newsletterNewsletterSettings
Oppsettet slik det nå er.
mirroredboolean
false når vi ikke nådde fram til publikasjonen akkurat da. Da er oppsettet lagret, men neste brev går ut slik det så ut før.
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/newsletter" \
  -X PATCH \
  -H "content-type: application/json" \
  -d '{
    "body_mode": "full",
    "signoff": "Takk for at du leser."
  }'

Objekter

NewsletterSettings

Hvordan nyhetsbrevet ser ut, hva det sier og hvem det går til.

Felter

body_modestring
Hvor mye av innlegget som følger med i e-posten. teaser er tittel, ingress og en lenke videre. full er hele teksten rett i innboksen. Betalt innhold sendes uansett bare som den gratis smakebiten.teaserfull
audiencestring
Hvem som får e-post når du publiserer et innlegg. all er alle bekreftede abonnenter, paid bare de betalende. Gjelder utsendingen som skjer av seg selv ved publisering.allpaid
greetingstring
Linja over innlegget, med dine egne ord. Inntil 140 tegn; er den lengre, avviser vi den heller enn å korte den ned.
signoffstring
Linja under innlegget. Står den tom, signerer vi med navnet på publikasjonen. Inntil 240 tegn; er den lengre, avviser vi den heller enn å korte den ned.
welcomestring
Hilsenen en ny abonnent får i velkomstbrevet. Inntil 600 tegn; er den lengre, avviser vi den heller enn å korte den ned.
logo_urlstring
Adressen til logoen øverst i e-posten. Tom streng fjerner den, og da faller vi tilbake på logoen bloggen bruker. Topptekst med logo vises bare med Skribb Mer; uten den lagres adressen, men e-posten viser navnet på publikasjonen i stedet. Inntil 500 tegn; er den lengre, avviser vi den heller enn å korte den ned.
reply_tostring
Adressen et svar på nyhetsbrevet går til. Tom streng skrur av svar. Krever Skribb Mer: uten den svarer ruta 409 premium-plan-required i stedet for å lagre stille. Inntil 254 tegn; er den lengre, avviser vi den heller enn å korte den ned.

← Alle rutene