Customize signup form

POST

https://api.mailchimp.com/3.0/lists/:list_id/signup-forms

POST

/3.0/lists/:list_id/signup-forms

curl -X POST https://api.mailchimp.com/3.0/lists/list_id/signup-forms \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Successful

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "contents": [
    {
      "section": "signup_message",
      "value": "Signup message goes here"
    }
  ],
  "header": {
    "image_align": "center",
    "image_alt": "This is an image",
    "image_border_color": "#896d6d",
    "image_border_style": "solid",
    "image_border_width": "2",
    "image_height": "200",
    "image_link": "gotothisimage.com",
    "image_target": "_blank",
    "image_url": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
    "image_width": "800",
    "text": "Header Text goes here"
  },
  "list_id": "4ca5becb8d",
  "signup_form_url": "string",
  "styles": [
    {
      "options": [
        {
          "property": "background-color",
          "value": "#111111"
        }
      ],
      "selector": "page_background"
    }
  ]
}

Customize a list’s default signup form.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

list_idstringRequired

The unique ID for the list.

Request

List signup form.

contentslist of objectsOptional

The signup form body content.

headerobjectOptional

Options for customizing your signup form header.

styleslist of objectsOptional

An array of objects, each representing an element style for the signup form.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

contentslist of objectsOptional

The signup form body content.

headerobjectOptional

Options for customizing your signup form header.

list_idstringOptionalRead-only

The signup form's list id.

signup_form_urlstringOptional

Signup form URL.

styleslist of objectsOptional

An array of objects, each representing an element style for the signup form.