Returns status code

200

Request url

/custom-fields?fields=name&sort[name]=desc&page=4&perPage=30

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
sorthashEnable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.
KeyPossible values if fixed
nameasc,desc
pageintegerSpecify which page of results return.
perPageintegerSpecify how many results per page should be returned

Example Response

[
    {
        "customFieldId": "Vit",
        "href": "http://api.getresponse.com/v3/custom-fields/Vit",
        "name": "ref",
        "fieldType": "multi_select",
        "valueType": "string",
        "type": "text",
        "hidden": "false",
        "values": []
    }
]

Returns status code

200

Request url

/custom-fields/V?fields=name

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "customFieldId": "pas",
    "name": "color",
    "fieldType": "multi_select",
    "valueType": "string",
    "type": "checkbox",
    "hidden": "false",
    "values": [
        "green",
        "red"
    ]
}

Custom field name must meet the following requirements:

  • from 1 to 32 characters long
  • be unique
  • use only lowercase letters, underscores and digits
  • not be equal to one of the merge words used in messages, i.e. name, email, twitter, facebook, buzz, myspace, linkedin, digg, googleplus, pinterest, responder, campaign, change

Custom field "type" accepts following values:

  • number - text input for numeric value (does not require values in "values" field, you can pass empty array)
  • date - text input for date (does not require values in "values" field, you can pass empty array)
  • datetime - text input for datetime (does not require values in "values" field, you can pass empty array)
  • country - multi select input for country (requires at least 2 country names in "values" field)
  • currency - multi select for currency, allows all ISO 4217 currency codes (requires at least 2 currency codes in "values" field)
  • phone - text input for phone (does not require values in "values" field, you can pass empty array)
  • gender - radio input for gender (requires 2 values in "values" field: "Male" and "Female" that can be translated into one of the languages supported by GetResponse)
  • ip - text input for IP address (does not require values in "values" field, you can pass empty array)
  • url - text input for URL (does not require values in "values" field, you can pass empty array)
  • text - text input (does not require values in "values" field, you can pass empty array)
  • textarea - textarea input (does not require values in "values" field, you can pass empty array)
  • radio - radio input (requires at least 2 values in "values" field)
  • checkbox - checkbox input (requires at least 2 values in "values" field)
  • single_select - single select input (requires at least 2 values in "values" field)
  • multi_select - multi select input (requires at least 2 values in "values" field)

Returns status code

201

Example Request Body

{
    "name": "color",
    "type": "checkbox",
    "hidden": "false",
    "values": [
        "green",
        "red"
    ]
}

Body params

Field nameField typeField description
name (required)stringName of the custom field
type (required)stringType of custom field value, please see description
hidden (required)boolFlag if custom field is visible to contact
values (required)setList of assigned default values (zero or more - depending on custom field type, please see description )

Example Response

{
    "customFieldId": "pas",
    "name": "color",
    "type": "checkbox",
    "fieldType": "multi_select",
    "valueType": "string",
    "hidden": "false",
    "values": [
        "green",
        "red"
    ]
}

Possible Errors


Returns status code

204

Possible Errors


Custom field name must meet the following requirements:

  • from 1 to 32 characters long
  • be unique
  • use only lowercase letters, underscores and digits
  • not be equal to one of the merge words used in messages, i.e. name, email, twitter, facebook, buzz, myspace, linkedin, digg, googleplus, pinterest, responder, campaign, change

Returns status code

201

Example Request Body

{
    "hidden": "false",
    "values": [
        "green",
        "red",
        "blue"
    ]
}

Body params

Field nameField typeField description
hiddenboolFlag if custom field is visible to contact
valuesetList of assigned values (zero or more - depending of customField type)

Example Response

{
    "customFieldId": "pas",
    "name": "color",
    "fieldType": "multi_select",
    "valueType": "string",
    "type": "checkbox",
    "hidden": "false",
    "values": [
        "green",
        "red",
        "blue"
    ]
}

Possible Errors