Sign-up pages

A sign-up page is a page AgentsMail hosts for you at a public address. Visitors leave their email address on it and become contacts in one list. These endpoints create, read, change and remove those pages — the same objects the Audience → Sign-up pages screen manages. A page is a theme plus a handful of named settings. There is no page builder here and none is needed: content is the HTML of the page, and everything else is a field.

The two things a page always needs

  1. A list. listId says where the addresses go, and it must be a list of your organization — one page feeds exactly one list. Get the id from List the lists.
  2. {{form}} in the HTML. It is the placeholder the form itself replaces. Without it the page would render with no field to fill in, so saving is refused with 400 and the message names the placeholder that is missing.
The other placeholders are optional: {{heroTitle}}, {{heroSubtitle}}, {{organizationName}} and {{poweredBy}}. Leave one out and the corresponding text simply is not rendered.

Published or draft

status is draft or published. A published page answers at its public address; a draft page answers a not-found page and collects nothing. Create without status and you get a draft — provisioning a page never puts an address online by accident. The public address is https://www.agentsmail.io/public/{organizationSlug}/subscribe/{slug}, where slug is the field you set on the page.

Starting from a theme

Browse the theme catalogue returns the themes we maintain. Choosing one is a copy: take its content, send it as your page's content, and put its name in sourceTemplateName so the screen can say where the page came from. Nothing that happens to the catalogue afterwards changes a page you already created.

What refuses

  • A slug already used by another of your pages — 409, and the message names the page that holds the address.
  • HTML without {{form}} — 400.
  • A listId that belongs to another organization — 404, exactly like an unknown list.
  • A redirectUrl that is not http:// or https:// — 400.
See Sign-up pages for what a visitor sees and what happens when somebody signs up.