Formularët
`forms.list`, `get`, `create`, `update`, `delete`, `publish`, `pause`, `resume`, `duplicate`, `analytics`, `list_starters`, `get_starter`, `list_submissions`, `get_submission`, `delete_submission`, `delete_submissions`, `approve_submission`, `resend_confirmation` dhe `subscribe`.
Çdo metodë
from openemail import openemail form = openemail.forms.create({ 'name': 'Newsletter sign-up', 'starter': 'newsletter', 'settings': {'audienceIds': ['aud_4c1b8e2a7d9f05c36b4e8a71']}, 'publish': True,}) print(form['url'], form['subscribeUrl']) saved = openemail.forms.update(form['id'], { 'settings': {'doubleOptIn': True, 'senderAddress': '[email protected]'}, 'expectedUpdatedAt': form['updatedAt'],}) signup = openemail.forms.subscribe(form['id'], { 'email': '[email protected]', 'first_name': 'Ann', 'consent': True,}) for submission in openemail.forms.iterate_submissions(form['id'], status='pending'): if submission['expired']: openemail.forms.resend_confirmation(form['id'], submission['id']) stats = openemail.forms.analytics(form['id'], days=30)starters = openemail.forms.list_starters() openemail.forms.pause(form['id'])openemail.forms.resume(form['id'])copy = openemail.forms.duplicate(form['id'])openemail.forms.delete(copy['id']) print(saved['senderIssue'], signup['outcome'], stats['totals']['conversion'], len(starters))Një formular mban një skicë document dhe publishedDocument që shohin vizitorët. update ndryshon skicën dhe cilësimet, dhe publish e bën skicën aktive. Cilësimet hyjnë në fuqi menjëherë, qoftë formulari i publikuar apo jo, dhe expectedUpdatedAt refuzon me 409 version_conflict një ruajtje që do të mbishkruante ruajtjen e dikujt tjetër.
Leximi kërkon forms:read dhe ndryshimi kërkon forms:write. approve_submission kërkon edhe contacts:write, sepse shton një kontakt. resend_confirmation kërkon edhe emails:send, ashtu si edhe një thirrje që e bën formularin të dërgojë postë: aktivizimi i doubleOptIn, caktimi i senderAddress ose i emailit të konfirmimit, ose publikimi apo rifillimi i një formulari me konfirmim të dyfishtë. delete i kërkon një tokeni aksesi OAuth një kod verifikimi, ndërsa një çelësi API kurrë.
subscribe e regjistron dikë ashtu siç bën faqja e formularit dhe nuk dërgon kredenciale, edhe nga një klient që i ka. Të gjitha regjistrimet nga një rrjet ndajnë një kufi prej 40 në çdo dhjetë minuta, ndaj një server që përcjell regjistrime për shumë njerëz e arrin shpejt: njerëzit që i njihni tashmë shtojini më mirë me audiences.import_contacts. Kaloni faqen ku ishte formulari si oe_source, lini jashtë oe_started, dhe dërgojeni oe_website bosh ose mos e dërgoni fare.
Një 422 nga subscribe është invalid_form_submission, dhe fields e gabimit liston çdo përgjigje që mungon ose nuk është e vlefshme si {'key': ..., 'error': ...}, me arsye si required, email dhe option. Klienti është për serverë. Në një shfletues, dërgojini përgjigjet me fetch te subscribeUrl i formularit, si trup JSON ose me një header Accept: application/json, dhe ai përgjigjet me JSON nga çdo origjinë. Pa asnjërën prej tyre, përgjigjet me një ridrejtim 303 drejt faqes së strehuar.
Përgjigje: FormDetailResource
list kthen një faqe me FormResource, nga më i riu, pa document dhe settings, dhe list_all e iterate përshkojnë të gjitha faqet. get, create, update, publish, pause, resume dhe duplicate kthejnë një FormDetailResource, që shton document, publishedDocument, settings, audiences, senderIssue dhe senderProblem.
idstr- Identifikuesi i qëndrueshëm, `frm_` i ndjekur nga 24 karaktere hex.
statusLiteral['draft', 'live', 'paused']- `draft` deri në publikimin e parë, pastaj `live` sa kohë pranon regjistrime dhe `paused` sa kohë nuk pranon. Një formular nuk kthehet kurrë në `draft`.
urlstr- Faqja e strehuar e formularit të publikuar, për ta ndarë si lidhje.
subscribeUrlstr- Ku i dërgon përgjigjet një formular HTML i thjeshtë, ose `fetch`.
documentFormDocument- Skica: `fields` sipas radhës, tekstet `copy` përreth tyre dhe `style`.
publishedDocumentFormDocument | None- Ajo që shohin vizitorët tani. `None` deri në publikimin e parë.
settingsFormSettings- Ku shkojnë regjistrimet dhe çfarë ndodh pas një regjistrimi: `audienceIds`, `doubleOptIn`, `senderAddress`, emaili i konfirmimit, `successAction`, `redirectUrl` dhe `notifyAddresses`.
hasUnpublishedChangesbool- `True` kur drafti ndryshon nga ajo që shohin vizitorët. Gjithmonë `False` para publikimit të parë.
senderIssueLiteral['missing', 'not_sendable', 'not_allowed'] | None- Pse një formular me konfirmim të dyfishtë nuk mund t'i dërgojë tani emailet e konfirmimit, ose `None` kur mundet.
statsFormStats- `views`, `submissions`, `added`, `pending` dhe `lastSubmittedAt`, të numëruara në çastin e leximit.
Parashtrimet
list_submissions kthen faqe nga më i riu, me q për të kërkuar në adresat e emailit dhe status për pending ose added, dhe list_all_submissions e iterate_submissions përshkojnë të gjitha faqet. Çdo FormSubmissionResource i mban përgjigjet ashtu siç u dërguan, bashkë me etiketat, ndaj lexohet ende saktë pasi ndryshon formulari.
resend_confirmation kthen parashtrimin me confirmationSent. Është False kur nuk u nis asgjë: një adresë merr një konfirmim për formular çdo dhjetë minuta dhe pesë në ditë në gjithë hapësirën e punës, dhe një parashtrim i shtuar nuk merr asnjë. expired shënon një regjistrim në pritje lidhja e fundit e të cilit ka skaduar.
Referencë
forms.list()Referenca e plotëforms.list_all()Referenca e plotëforms.iterate()Referenca e plotëforms.get()Referenca e plotëforms.create()Referenca e plotëforms.update()Referenca e plotëforms.delete()Referenca e plotëforms.publish()Referenca e plotëforms.pause()Referenca e plotëforms.resume()Referenca e plotëforms.duplicate()Referenca e plotëforms.analytics()Referenca e plotëforms.list_starters()Referenca e plotëforms.get_starter()Referenca e plotëforms.list_submissions()Referenca e plotëforms.list_all_submissions()Referenca e plotëforms.iterate_submissions()Referenca e plotëforms.get_submission()Referenca e plotëforms.delete_submission()Referenca e plotëforms.delete_submissions()Referenca e plotëforms.approve_submission()Referenca e plotëforms.resend_confirmation()Referenca e plotëforms.subscribe()Referenca e plotë