Contact List — Form¶
Subscription form entity for a contact list.
Endpoints¶
| Method | URL |
|---|---|
GET |
/contact_list/<list>/form/<form> |
POST |
/contact_list/<list>/form |
PUT |
/contact_list/<list>/form/<form> |
DELETE |
/contact_list/<list>/form/<form> |
GET /contact_list/<list>/form/<form>¶
Payload: No payload.
Returns: The form.
POST /contact_list/<list>/form¶
| Parameter | Type | Description |
|---|---|---|
name |
string | Form name |
action |
string | On submission: message (show success message) or redirect (redirect to URL) |
redirect_url |
string | Redirect destination when action is "redirect" |
message_text |
string | Success message text when action is "message" |
allowed_referred_domains[] |
string array | Domains from which to accept submissions. May occur multiple times. If empty, no referrer check is done. |
Returns: The new form.
PUT /contact_list/<list>/form/<form>¶
Same payload as POST.
Returns: The edited form.
DELETE /contact_list/<list>/form/<form>¶
Payload: No payload.
Returns: The deleted form.