Landing Pages

Manage your Landing Pages, including publishing and unpublishing.

Subresources

Available methods

    • POST /landing-pages Create a new landing page

      Create a new landing page

      POST /landing-pages

      Create a new Mailchimp landing page.

      Request body parameters

      name Type: String Title: Landing Page Name Read only: false The name of this landing page.
      title Type: String Title: Landing Page title Read only: false The title of this landing page seen in the browser’s title bar.
      description Type: String Title: Landing Page description Read only: false The description of this landing page.
      store_id Type: String Title: Store ID Read only: false The ID of the store associated with this landing page.
      list_id Type: String Title: Landing Page list id Read only: false The list’s ID associated with this landing page.
      type Type: String Title: Landing Page Template Type Read only: false The type of template the landing page has.

      Response body parameters

      id Type: String Title: Landing Page ID Read only: false A string that uniquely identifies this landing page.
      name Type: String Title: Landing Page Name Read only: false The name of this landing page.
      title Type: String Title: Landing Page title Read only: false The title of this landing page seen in the browser’s title bar.
      description Type: String Title: Landing Page description Read only: false The description of this landing page.
      template_id Type: Integer Title: Landing Page template_id Read only: true The template_id of this landing page.
      status Type: String Title: Landing Page status Read only: true The status of this landing page.
      list_id Type: String Title: Landing Page list id Read only: false The list’s ID associated with this landing page.
      store_id Type: String Title: Store ID Read only: false The ID of the store associated with this landing page.
      url Type: String Title: Published url Read only: true The url of the published landing page.
      created_at Type: String Title: Created At Read only: true The time this landing page was created.
      published_at Type: String Title: Published at Read only: true The time this landing page was published.
      unpublished_at Type: String Title: Unpublished at Read only: true The time this landing page was unpublished.
      updated_at Type: String Title: Updated_at Read only: true The time this landing page was updated at.
      _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.

      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 /landing-pages No Summary
      GET /landing-pages/{page_id} Get information about a specific page

      No Summary

      GET /landing-pages

      Get all landing pages.

      Query string parameters

      sort_dir Type: String Title: Sort Direction Read only: false Determines the order direction for sorted results.
      Possible Values:
      • ASC
      • DESC
      sort_field Type: String Title: Sort By Field Read only: false Returns files sorted by the specified field.
      Possible Values:
      • created_at
      • updated_at
      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.

      Response body parameters

      landing_pages Type: Array Title: No Title Read only: false No Description
      Show properties
      id Type: String Title: Landing Page ID Read only: false A string that uniquely identifies this landing page.
      name Type: String Title: Landing Page Name Read only: false The name of this landing page.
      title Type: String Title: Landing Page title Read only: false The title of this landing page seen in the browser’s title bar.
      description Type: String Title: Landing Page description Read only: false The description of this landing page.
      template_id Type: Integer Title: Landing Page template_id Read only: true The template_id of this landing page.
      status Type: String Title: Landing Page status Read only: true The status of this landing page.
      list_id Type: String Title: Landing Page list id Read only: false The list’s ID associated with this landing page.
      store_id Type: String Title: Store ID Read only: false The ID of the store associated with this landing page.
      url Type: String Title: Published url Read only: true The url of the published landing page.
      created_at Type: String Title: Created At Read only: true The time this landing page was created.
      published_at Type: String Title: Published at Read only: true The time this landing page was published.
      unpublished_at Type: String Title: Unpublished at Read only: true The time this landing page was unpublished.
      updated_at Type: String Title: Updated_at Read only: true The time this landing page was updated at.
      _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.
      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.

      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 information about a specific page

      GET /landing-pages/{page_id}

      Get information about a specific page.

      Path parameters

      id The unique id for the page.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      id Type: String Title: Landing Page ID Read only: false A string that uniquely identifies this landing page.
      name Type: String Title: Landing Page Name Read only: false The name of this landing page.
      title Type: String Title: Landing Page title Read only: false The title of this landing page seen in the browser’s title bar.
      description Type: String Title: Landing Page description Read only: false The description of this landing page.
      template_id Type: Integer Title: Landing Page template_id Read only: true The template_id of this landing page.
      status Type: String Title: Landing Page status Read only: true The status of this landing page.
      list_id Type: String Title: Landing Page list id Read only: false The list’s ID associated with this landing page.
      store_id Type: String Title: Store ID Read only: false The ID of the store associated with this landing page.
      url Type: String Title: Published url Read only: true The url of the published landing page.
      created_at Type: String Title: Created At Read only: true The time this landing page was created.
      published_at Type: String Title: Published at Read only: true The time this landing page was published.
      unpublished_at Type: String Title: Unpublished at Read only: true The time this landing page was unpublished.
      updated_at Type: String Title: Updated_at Read only: true The time this landing page was updated at.
      _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.

      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.
    • Update landing page

      PATCH /landing-pages/{page_id}

      Update a landing page.

      Path parameters

      landing_page_id A string that uniquely identifies this landing page.

      Request body parameters

      name Type: String Title: Landing Page Name Read only: false The name of this landing page.
      title Type: String Title: Landing Page title Read only: false The title of this landing page seen in the browser’s title bar.
      description Type: String Title: Landing Page description Read only: false The description of this landing page.
      store_id Type: String Title: Store ID Read only: false The ID of the store associated with this landing page.
      list_id Type: String Title: Landing Page list id Read only: false The list’s ID associated with this landing page.

      Response body parameters

      id Type: String Title: Landing Page ID Read only: false A string that uniquely identifies this landing page.
      name Type: String Title: Landing Page Name Read only: false The name of this landing page.
      title Type: String Title: Landing Page title Read only: false The title of this landing page seen in the browser’s title bar.
      description Type: String Title: Landing Page description Read only: false The description of this landing page.
      template_id Type: Integer Title: Landing Page template_id Read only: true The template_id of this landing page.
      status Type: String Title: Landing Page status Read only: true The status of this landing page.
      list_id Type: String Title: Landing Page list id Read only: false The list’s ID associated with this landing page.
      store_id Type: String Title: Store ID Read only: false The ID of the store associated with this landing page.
      url Type: String Title: Published url Read only: true The url of the published landing page.
      created_at Type: String Title: Created At Read only: true The time this landing page was created.
      published_at Type: String Title: Published at Read only: true The time this landing page was published.
      unpublished_at Type: String Title: Unpublished at Read only: true The time this landing page was unpublished.
      updated_at Type: String Title: Updated_at Read only: true The time this landing page was updated at.
      _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.

      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.
    • DELETE /landing-pages/{page_id} Delete a landing page

      Delete a landing page

      DELETE /landing-pages/{page_id}

      Delete a landing page.

      Path parameters

      landing_page_id A string that uniquely identifies this landing page.

      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.
    • Publish a landing page

      POST /landing-pages/{page_id}/actions/publish

      Publish a landing page that is in draft, unpublished, or has been previously published and edited.

      Path parameters

      id The unique id for the page.

      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.

      Unpublish a landing page

      POST /landing-pages/{page_id}/actions/unpublish

      Unpublish a landing page that is in draft or has been published.

      Path parameters

      id The unique id for the page.

      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.