Method :POST

URL: https://apiv1.publicators.com/api/Forms/CreateForm

Create new Form

Request Information

URI Parameters

None.

Body Parameters

Json format: FormCreateNewBindingModel

FormCreateNewBindingModel
NameDescriptionTypeAdditional information
form_name

New Form Name. Max length: 100 characters long.

string

Required

form_notify_toemail

Email to be notified for each newly registered Max length: 100 characters long.

string

None.

form_optin

Recipient inserted as approval status

boolean

Required

form_lang

Form language

FormLangType

Required

list_id

List ID

integer

Required

Auth

Authorization Token

AuthorizationTokenBindingModel

Required

Request Formats

application/json, text/json

Sample:
{
  "form_name": "sample string 1",
  "form_notify_toemail": "sample string 2",
  "form_optin": true,
  "form_lang": 0,
  "list_id": 4,
  "Auth": {
    "Token": "67714534-3c69-4b9e-b846-7f519427de13"
  }
}

Response Information

Resource Description

Json format: FormViewModel of the new form

FormViewModel
NameDescriptionTypeAdditional information
form_id

Form Id

integer

None.

form_name

Form name

string

None.

form_notify_toemail

Email to be notified for each newly registered

string

None.

list_id

List Id to store the newly registered

integer

None.

form_optin

Recipient inserted as approval status

boolean

None.

form_created

Form Date Created DateTime format yyyy/MM/dd HH:mm:ss

date

None.

form_lang

Form language

FormLangType

None.

FormLink

Return custom link

string

None.

Response Formats

application/json, text/json

Sample:
{
  "form_id": 1,
  "form_name": "sample string 2",
  "form_notify_toemail": "sample string 3",
  "list_id": 4,
  "form_optin": true,
  "form_created": "2023/10/02 07:27:20",
  "form_lang": 0,
  "FormLink": "sample string 7"
}