Signup Forms

Manage list signup forms.

Available methods

    • POST /lists/{list_id}/signup-forms Customize the signup form settings for a specific list

      Customize the signup form settings for a specific list

      POST /lists/{list_id}/signup-forms

      Customize a list’s default signup form.

      Path parameters

      list_id The unique id for the list.

      Request body parameters

      header Type: Object Title: Signup form header options Read only: false Options for customizing your signup form header.
      Show properties
      image_url Type: String Title: Header Image URL Read only: false Header image URL.
      text Type: String Title: Header Text Read only: false Header text.
      image_width Type: String Title: Image width Read only: false Image width, in pixels.
      image_height Type: String Title: Image height Read only: false Image height, in pixels.
      image_alt Type: String Title: Image Alt Read only: false Alt text for the image.
      image_link Type: String Title: Image Link Read only: false The URL that the header image will link to.
      image_align Type: String Title: Image align Read only: false Image alignment.
      Possible Values:
      • none
      • left
      • center
      • right
      image_border_width Type: String Title: Image border width Read only: false Image border width.
      image_border_style Type: String Title: Image border style Read only: false Image border style.
      Possible Values:
      • none
      • solid
      • dotted
      • dashed
      • double
      • groove
      • outset
      • inset
      • ridge
      image_border_color Type: String Title: Image border color Read only: false Image border color.
      image_target Type: String Title: Image target Read only: false Image link target.
      Possible Values:
      • _blank
      • null
      contents Type: Array Title: Signup form body content Read only: false The signup form body content.
      Show properties
      section Type: String Title: Content Section Name Read only: false The content section name.
      Possible Values:
      • signup_message
      • unsub_message
      • signup_thank_you_title
      value Type: String Title: Content Section Value Read only: false The content section text.
      styles Type: Array Title: Signup Form element style Read only: false An array of objects, each representing an element style for the signup form.
      Show properties
      selector Type: String Title: Selector Read only: false A string that identifies the element selector.
      Possible Values:
      • page_background
      • page_header
      • page_outer_wrapper
      • body_background
      • body_link_style
      • forms_buttons
      • forms_buttons_hovered
      • forms_field_label
      • forms_field_text
      • forms_required
      • forms_required_legend
      • forms_help_text
      • forms_errors
      • monkey_rewards_badge
      options Type: Array Title: Options Read only: false A collection of options for a selector.
      Show properties
      property Type: String Title: Property Read only: false A string that identifies the property.
      value Type: String Title: Value Read only: false A string that identifies value of the property.

      Response body parameters

      header Type: Object Title: Signup form header options Read only: false Options for customizing your signup form header.
      Show properties
      image_url Type: String Title: Header Image URL Read only: false Header image URL.
      text Type: String Title: Header Text Read only: false Header text.
      image_width Type: String Title: Image width Read only: false Image width, in pixels.
      image_height Type: String Title: Image height Read only: false Image height, in pixels.
      image_alt Type: String Title: Image Alt Read only: false Alt text for the image.
      image_link Type: String Title: Image Link Read only: false The URL that the header image will link to.
      image_align Type: String Title: Image align Read only: false Image alignment.
      Possible Values:
      • none
      • left
      • center
      • right
      image_border_width Type: String Title: Image border width Read only: false Image border width.
      image_border_style Type: String Title: Image border style Read only: false Image border style.
      Possible Values:
      • none
      • solid
      • dotted
      • dashed
      • double
      • groove
      • outset
      • inset
      • ridge
      image_border_color Type: String Title: Image border color Read only: false Image border color.
      image_target Type: String Title: Image target Read only: false Image link target.
      Possible Values:
      • _blank
      • null
      contents Type: Array Title: Signup form body content Read only: false The signup form body content.
      Show properties
      section Type: String Title: Content Section Name Read only: false The content section name.
      Possible Values:
      • signup_message
      • unsub_message
      • signup_thank_you_title
      value Type: String Title: Content Section Value Read only: false The content section text.
      styles Type: Array Title: Signup Form element style Read only: false An array of objects, each representing an element style for the signup form.
      Show properties
      selector Type: String Title: Selector Read only: false A string that identifies the element selector.
      Possible Values:
      • page_background
      • page_header
      • page_outer_wrapper
      • body_background
      • body_link_style
      • forms_buttons
      • forms_buttons_hovered
      • forms_field_label
      • forms_field_text
      • forms_required
      • forms_required_legend
      • forms_help_text
      • forms_errors
      • monkey_rewards_badge
      options Type: Array Title: Options Read only: false A collection of options for a selector.
      Show properties
      property Type: String Title: Property Read only: false A string that identifies the property.
      value Type: String Title: Value Read only: false A string that identifies value of the property.
      signup_form_url Type: String Title: Signup form URL Read only: false Signup form URL.
      list_id Type: String Title: List ID Read only: true The signup form’s list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/signup-forms' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"header": {"image_url": "https://static.mailchimp.com/web/brand-assets/mc_freddie_color_web.png", "text": "Freddie'\''s Favorite Jokes", "image_link": "http://freddiesjokes.com/", "image_align": "center"}, "contents": [{"section": "signup_message", "value": "You'\''ve subscribed to Freddie'\''s Joke of the Day!"}, {"section": "unsub_message", "value": "You'\''ve unsubscribed from Freddie'\''s Joke of the Day."}, {"section": "signup_thank_you_title", "value": "Thanks for signing up!"}]}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 07 Sep 2016 15:57:28 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 957
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 9a4f3dc2-23d6-48ab-8260-8df4ea21e49a
      Link: <https://api.mailchimp.com/schema/3.0/Lists/SignupForms/Instance.json>; rel="describedBy"
      
      {
        "header": {
          "image_url": "https://static.mailchimp.com/web/brand-assets/mc_freddie_color_web.png",
          "text": "",
          "image_width": "476",
          "image_height": "499",
          "image_alt": "",
          "image_link": "http://freddiesjokes.com/",
          "image_align": "center",
          "image_border_width": "0",
          "image_border_style": "",
          "image_border_color": "",
          "image_target": ""
        },
        "contents": [
          {
            "section": "signup_message",
            "value": "You've subscribed to Freddie's Joke of the Day!"
          },
          {
            "section": "unsub_message",
            "value": "You've unsubscribed from Freddie's Joke of the Day."
          },
          {
            "section": "signup_thank_you_title",
            "value": "Thanks for signing up!"
          }
        ],
        "styles": [],
        "signup_form_url": "http://eepurl.com/bPlnhz",
        "list_id": "205d96e6b4",
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/signup-forms",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/SignupForms/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/SignupForms.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • GET /lists/{list_id}/signup-forms Get signup forms for a specific list

      Get signup forms for a specific list

      GET /lists/{list_id}/signup-forms

      Get signup forms for a specific list.

      Path parameters

      list_id The unique id for the list.

      Response body parameters

      signup_forms Type: Array Title: List Signup Form Read only: false List signup form.
      Show properties
      header Type: Object Title: Signup form header options Read only: false Options for customizing your signup form header.
      Show properties
      image_url Type: String Title: Header Image URL Read only: false Header image URL.
      text Type: String Title: Header Text Read only: false Header text.
      image_width Type: String Title: Image width Read only: false Image width, in pixels.
      image_height Type: String Title: Image height Read only: false Image height, in pixels.
      image_alt Type: String Title: Image Alt Read only: false Alt text for the image.
      image_link Type: String Title: Image Link Read only: false The URL that the header image will link to.
      image_align Type: String Title: Image align Read only: false Image alignment.
      Possible Values:
      • none
      • left
      • center
      • right
      image_border_width Type: String Title: Image border width Read only: false Image border width.
      image_border_style Type: String Title: Image border style Read only: false Image border style.
      Possible Values:
      • none
      • solid
      • dotted
      • dashed
      • double
      • groove
      • outset
      • inset
      • ridge
      image_border_color Type: String Title: Image border color Read only: false Image border color.
      image_target Type: String Title: Image target Read only: false Image link target.
      Possible Values:
      • _blank
      • null
      contents Type: Array Title: Signup form body content Read only: false The signup form body content.
      Show properties
      section Type: String Title: Content Section Name Read only: false The content section name.
      Possible Values:
      • signup_message
      • unsub_message
      • signup_thank_you_title
      value Type: String Title: Content Section Value Read only: false The content section text.
      styles Type: Array Title: Signup Form element style Read only: false An array of objects, each representing an element style for the signup form.
      Show properties
      selector Type: String Title: Selector Read only: false A string that identifies the element selector.
      Possible Values:
      • page_background
      • page_header
      • page_outer_wrapper
      • body_background
      • body_link_style
      • forms_buttons
      • forms_buttons_hovered
      • forms_field_label
      • forms_field_text
      • forms_required
      • forms_required_legend
      • forms_help_text
      • forms_errors
      • monkey_rewards_badge
      options Type: Array Title: Options Read only: false A collection of options for a selector.
      Show properties
      property Type: String Title: Property Read only: false A string that identifies the property.
      value Type: String Title: Value Read only: false A string that identifies value of the property.
      signup_form_url Type: String Title: Signup form URL Read only: false Signup form URL.
      list_id Type: String Title: List ID Read only: true The signup form’s list id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      list_id Type: String Title: List ID Read only: false The list id.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/signup-forms' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 07 Sep 2016 15:58:23 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 1680
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 45ff5211-0dc2-4676-bd78-8b9c1df2a3fd
      Link: <https://api.mailchimp.com/schema/3.0/Lists/SignupForms/Collection.json>; rel="describedBy"
      
      {
        "signup_forms": [
          {
            "header": {
              "image_url": "https://static.mailchimp.com/web/brand-assets/mc_freddie_color_web.png",
              "text": "",
              "image_width": "476",
              "image_height": "499",
              "image_alt": "",
              "image_link": "http://freddiesjokes.com/",
              "image_align": "center",
              "image_border_width": "0",
              "image_border_style": "",
              "image_border_color": "",
              "image_target": ""
            },
            "contents": [
              {
                "section": "signup_message",
                "value": "You've subscribed to Freddie's Joke of the Day!"
              },
              {
                "section": "unsub_message",
                "value": "You've unsubscribed from Freddie's Joke of the Day."
              },
              {
                "section": "signup_thank_you_title",
                "value": "Thanks for signing up!"
              }
            ],
            "styles": [],
            "signup_form_url": "http://eepurl.com/bPlnhz",
            "list_id": "205d96e6b4",
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/signup-forms",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/SignupForms/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/SignupForms.json"
              }
            ]
          }
        ],
        "list_id": "205d96e6b4",
        "total_items": 1,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/signup-forms",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/SignupForms/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/SignupForms.json"
          },
          {
            "rel": "update",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/signup-forms",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/SignupForms/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.