What can I do with form?

The attributes available for the form resource are currently limited. More available soon!

  • Filter by user_id for a list of forms created by a particular user.

GET /form or /form/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the form.
gacode
stringNoNoGoogle Analytics tracking code.
name
stringYesYesForm name.
suppressoptin
intNoNoDoes not send the subscriber an opt-in email if they have an existing subscription.
user_id
intNoNoUnique ID of the user who created this form.
cdate
decimalNoYesCreation timestamp.
mdate
decimalNoNoLast modification timestamp.

Legacy forms are not available through this endpoint. You can read about converting a legacy form in our Knowledge base.

If your company is restricting access to folders and the user is not an admin, the collection of available forms will be constrained to those created by the user.

HEAD /form or /form/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the form.
name
stringOptionalForm name.

POST /form

Method coming soon!

PUT /form or /form/:id

Method coming soon!

DELETE /form or /form/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the form.

If the authenticated user is not an admin, the user can only delete forms they created.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":               1,
    "gacode":           "UA-123456789",
    "name":             "Marketing Automation Form",
    "suppressoptin":    true,
    "user_id":          405,
    "cdate":            1353579227,
    "mdate":            1353579301
}