Allows user (based on account owner ID) to get all forms of a specific type.


JSON Request Example:     

{
  "username": "DRB-Test",
  "usertoken": "a1de7f1e68e24201ad22a0cb166eee90c969237e",
  "requesttype": "Forms",
  "requestmethod": "GetForms",
  "details": {
    "owner": "{*owner_user_id*}", /* required */
    "type": "{*form_type*}"
  }
}


Null

"json_request" element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeForms
requestmethodGetForms


"details" element


Field NameDescription
owner
(Required)
The owner ID for the account
type
(optional)

The form type. There are four form types. Valid values are:
  • s or subscription or subscribe
  • m or modify
  • or forward
  • or unsubscribe

If no form type specified, will return all.


Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. User must specify a form type OR delete the  "type": "{*form_type*}" element. 

Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if form was successfully retrieved
dataForm type (single letter unless default "all" returned)
Form count retrieved

"response" detail


Field NameDescription
forms
Specific form ID
Form type
Form name
Owner ID for that form
The HTML code


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed