Create a New Signup Form

Use this endpoint to create a customized contact signup form. The newly created POST URL is provided in the response payload, and is associated with a specific user account. See Building a Custom Signup Form for requirements and best practices when creating a signup form.

Methods:

Click a method to view its documentation

POST

DescriptionTOP

Privileges required: contacts:signuptools:create

This endpoint creates a URL that can be used to add contacts to the Constant Contact account. In order to generate a POST URL, you need to provide the following information:

  • contact list(s) - You have the option of specifying list_ids, list_name or both:
    • one or more existing list_ids
      An invalid list_id will cause the call to fail with a 400 response.

    • a single list name - if the list_name does not exist, it will be created.
  • source - this is used to identify the partner or application that created the form

A successful request returns a signup_form_url that can be used to add contacts to the user account associated with the OAuth 2.0 access_token supplied in the request. 

POST: https://api.constantcontact.com/v2/signupform

Test API

name

type

default

description

api_key

query

REQUIRED; The API key of the application making the call

Example JSON Request BodyTOP

{
    "contact_lists":["list_id1","list_id2"],
    "list_name":"list_name",
    "source":"Partner Name"
}

Response CodesTOP

code

description

201

Signup form POST URL successfully created

400

Either JSON was malformed or there was a data validation error

401

Authentication failure

406

Unsupported Accept Header value; must be application/json

415

Unsupported content-type in header

500

Internal server error occurred

StructureTOP

property

type(max length)

description

contact_lists

array

Array of Contact List Ids that the new contact will be added to. REQUIRED if list_name is not specified.

list_name

string (255)

Specifies the name of the list that the new contact will be added to. The Contact list is created if it does not exist. REQUIRED if contact_lists are not specified.

signup_form_url

string

Read only. URL of the customer's sign up form, includes campaign activity id, https://visitor2.constantcontact.com/api/signup?ca=campaign_activity_id (Read Only)

source

string (255)

REQUIRED. Name of the application or partner that is building the signup form.

Example ResponseTOP

{
    "source": "Partner Name",
    "list_name": "list1",
    "signup_form_url": "https://visitor2.constantcontact.com/api/signup?ca=abcdef-123456-7890-c1253ab820c5"
}