Custom Fields API

Custom Fields API

Attributes

The POST request should have a JSON document in its payload with all of the following keys.

name

string

The name of this custom field.
field_type

string

The type of this custom field, see the “Custom Field Types” enumerated value below.
required

boolean

This custom field is required to be filled out for all subscribers.
instructions

string

Instructions on how this field should be used.

The response will have extra attributes in it that are used based upon the field type. See the tables below for details on these fields.

See the “Custom Field Types” enumerated value

Extra Attributes: Responses

The following keys are included when the custom field is sent back in a JSON response. These keys are not valid input values.

is_global

boolean

This custom field is global to the organization
Extra Attributes: text fields
default_string

string

The default value for this custom field
minimum_length

integer

The minimum length for this string (Note that if the field is not “Required”, then it can be blank regardless of this value)
maximum_length

integer

The maximum length for this string
interpolation_html_encode

boolean

This value will be encoded when replaced into HTML content (default true).
interpolation_url_encode

boolean

This value will be encoded when replaced into URLs upon click redirection (default true).
Extra Attributes: text_multiline fields
default_string

string

The default value for this custom field
minimum_length

integer

The minimum length for this string (Note that if the field is not “Required”, then it can be blank regardless of this value)
maximum_length

integer

The maximum length for this string
number_of_rows

integer

The number of rows that should be displayed when rendering this input field
interpolation_html_encode

boolean

This value will be encoded when replaced into HTML content (default true).
interpolation_html_newlines

boolean

This value will have its newlines replaced with <BR/> tags when replaced into HTML content (default true).
interpolation_url_encode

boolean

This value will be encoded when replaced into URLs upon click redirection (default true).
Extra Attributes: number fields
default_integer

integer

The default value for this custom field
minimum_value

integer

The minimum value for this number (Note that if the field is not “Required”, then it can be blank regardless of this value)
maximum_value

integer

The maximum value for this number
Extra Attributes: date and day_of_year fields

There are no extra attributes for these fields.

Extra Attributes: select_single_dropdown, select_single_radio, and select_multiple_checkboxes fields
options

array of hashes


An options array composed of the elements described below

name

string

The name of this option; The string value presented in dropdowns, radios, and checkboxes
Extra Attributes: boolean fields
default_boolean

boolean

This boolean custom field should / should not be selected by default

Get custom field details

URL

To get the custom fields that apply to a mailing list (this includes both custom fields that are attached to this mailing list and global custom fields):

GET /ga/api/v2/mailing_lists/:mailing_list_id/custom_fields

To get the custom fields that are global to the organization:

GET /ga/api/v2/custom_fields

Response

The response will be an array of custom field objects, as defined in the “Attributes” section above.

Example Response

  {
    "success": true,
    "data": [
      {
        "default_string": "",
        "field_type": "text",
        "id": 1,
        "instructions": "",
        "mailing_list_id": 1,
        "maximum_length": null,
        "minimum_length": null,
        "name": "Subscriber Name",
        "required": false,
        "is_global": false,
        "interpolation_html_encode": true,
        "interpolation_url_encode": true
      },
      {
        "field_type": "select_multiple_checkboxes",
        "id": 2,
        "instructions": "",
        "mailing_list_id": 1,
        "name": "Car Type",
        "required": false,
        "is_global": false,
        "options": [
          {
            "id": 2,
            "index": 2,
            "name": "Minivan"
          },
          {
            "id": 3,
            "index": 3,
            "name": "Passenger Car"
          },
          {
            "id": 4,
            "index": 4,
            "name": "Truck"
          },
          {
            "id": 5,
            "index": 5,
            "name": "Big Rig"
          }
        ]
      }
    ],
    "error_code": null,
    "error_message": null
  }

Create a new custom field

URL

To create a new custom field on a mailing list:

POST /ga/api/v2/mailing_lists/:mailing_list_id/custom_fields

To create a new custom field that is global to the organization:

POST /ga/api/v2/custom_fields

Request Parameters

mailing_list_id

integer

The id of the mailing list for this custom field

Request Payload

See the “Attributes” section above for an explanation of the custom field fields. The JSON object should be a child of the custom_field key.

Response

A successful response will return the custom field record as described below, in addition to the “Extra Parameters” listed above.

A failure will return a standard error response with an explanation of what went wrong.

Example

> POST /ga/api/v2/mailing_lists/1/custom_fields HTTP/1.1
> Authorization: Basic MTo1ZTk2NDY1Yzg4M2YzMzA5ZjAxMDVhMmUxMDc2NjMyYjY4N2U2MWQy
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8r zlib/1.2.5
> Host: SendSage-studio.dev
> Accept: */*

{
   "custom_field":{
      "default_string":"",
      "field_type":"text",
      "instructions":"",
      "maximum_length":2,
      "minimum_length":1,
      "name":"text",
      "required":false
   }
}

< HTTP/1.1 200 OK
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: Fri, 01 Jan 1990 00:00:00 GMT
< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< Set-Cookie: _session_id=458055a23f26f844e74f8cd7300f6445; path=/; HttpOnly
< X-Request-Id: f6e40d578ed1d9c418cca45e1b7fe532
< X-Runtime: 0.025540
< Connection: close

{
   "success":true,
   "data":{
      "default_string":"",
      "field_type":"text",
      "id":3,
      "instructions":"",
      "mailing_list_id":1,
      "maximum_length":2,
      "minimum_length":1,
      "name":"text",
      "required":false
   }
}

Update an existing custom field

URL

Update a custom field that is associated with a single mailing list:

PUT /ga/api/v2/mailing_lists/:mailing_list_id/custom_fields/:id

Update a custom field that is global to the organization:

PUT /ga/api/v2/custom_fields/:id

Request Parameters

id

integer

The id of the custom field
mailing_list_id

integer

The id of the mailing list for this custom field

Request Payload

The PUT request should have a JSON document in its payload in the same format as when creating a new custom field. Some or all of the parameters may be omitted when updating an existing record.

Response

A successful response will return the custom field record described in the “Create a new custom field” section above.

A failure will return a standard error response with an explanation of what went wrong.

Example

> PUT /ga/api/v2/mailing_lists/1/custom_fields/3 HTTP/1.1
> Authorization: Basic MTo1ZTk2NDY1Yzg4M2YzMzA5ZjAxMDVhMmUxMDc2NjMyYjY4N2U2MWQy
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8r zlib/1.2.5
> Host: SendSage-studio.dev
> Accept: */*

{
   "custom_field":{
      "maximum_length":200
   }
}

< HTTP/1.1 200 OK
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: Fri, 01 Jan 1990 00:00:00 GMT
< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< Set-Cookie: _session_id=458055a23f26f844e74f8cd7300f6445; path=/; HttpOnly
< X-Request-Id: f6e40d578ed1d9c418cca45e1b7fe532
< X-Runtime: 0.025540
< Connection: close

{
   "success":true,
   "data":{
      "default_string":"",
      "field_type":"text",
      "id":3,
      "instructions":"",
      "mailing_list_id":1,
      "maximum_length":200,
      "minimum_length":1,
      "name":"text",
      "required":false
   }
}

Deleting a custom field

URL

Delete a custom field that is associated with a single mailing list:

DELETE /ga/api/v2/mailing_lists/:mailing_list_id/custom_fields/:id

Delete a custom field that is global to the organization:

DELETE /ga/api/v2/custom_fields/:id

Request Parameters

id

integer

The id of the custom field
mailing_list_id

integer

The id of the mailing list for this custom field

Request Payload

This request has no payload.

Response

A successful response will return an empty success response:

{
  "success": true,
  "data": null,
  "error_code": null,
  "error_message": null
}

A failure will return a standard error response with an explanation of what went wrong. If the failure is due to other objects depending on this custom field to exist, the response data will contain a dependencies key. See an example of this below.

Example

> DELETE custom_fields/8 HTTP/1.1
> Authorization: Basic MTpjMmUzNzJmMDAxNmQyYWNhZDIyZjJjYzNhMzQwNWY4MDc5NWVlMThh
> Accept: application/json
> Content-Type: application/json

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "f744395dc73a323ce47b552d60a1c6cb"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: _session_id=3725ce5c714b5298dfddc07ddbf08cef; path=/; HttpOnly
< X-Request-Id: bb1debcd7215b30b540a26e6d7cff517
< X-Runtime: 0.018141
< Connection: close
< Server: thin 1.5.0 codename Knife

{
  "success": true,
  "data": null,
  "error_code": null,
  "error_message": null
}

Example of Failure Due to Dependency

> DELETE /ga/api/mailing_lists/1/custom_fields/7 HTTP/1.1
> Authorization: Basic MTpkNDViMTY2NDlkMDY4MTVmODY0OWQ3NjE4MjlmMDU2NGVjZGIwYzY5
> Accept: application/json
> Content-Type: application/json

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "22907c156bed7d48027b087627c58028"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: _session_id=bc11a218dbcbf70cba82a6b8fb99777f; path=/; HttpOnly
< X-Request-Id: baa60f34d5818207466c84cf055b54f9
< X-Runtime: 0.530502
< Connection: close
< Server: thin 1.5.0 codename Knife

{
  "success": false,
  "data": {
    "dependencies": [
      {
        "type": "campaign",
        "id": 1
      }
    ]
  },
  "error_code": "validation_failed",
  "error_message": "Cannot delete custom field because it is currently being used by the following records."
}

Promote a custom field

URL

Promote a custom field to be an organization global custom field:

POST /ga/api/v2/custom_fields/promote

Custom Fields that are associated with a single mailing list may be promoted to be global to the organization. Custom Fields must have a unique name across the organization in order to be promoted to be a global custom field.

Request Payload

custom_field_promoter

hash


custom_field_id

integer

id of the custom field to promote

Response

A successful response will return the same output as Create a new custom field.

A failure will return a standard error response with an explanation of what went wrong.

Example

> POST /ga/api/custom_fields/promote HTTP/1.1
> Authorization: Basic MTozNTZjNTg0ZWM4YWJlMWQ0NDY0OGZlMTY3MmVkM2ZlYmVkYTQxNWRh
> Accept: application/json
> Content-Type: application/json

{
  "promote": {
    "custom_field_id": 7
  }
}

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "e23799d92ddae1f210549ac8d6791e43"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: _session_id=92dd9834947ebd4336a18b11df1daa80; path=/; HttpOnly
< X-Request-Id: 84d088cd5055fd93cb28ebc156381405
< X-Runtime: 0.026102
< Connection: close
< Server: thin 1.5.0 codename Knife

{
  "success": true,
  "data": {
    "default_string": "",
    "field_type": "text",
    "id": 7,
    "instructions": "",
    "mailing_list_id": null,
    "maximum_length": null,
    "minimum_length": null,
    "name": "local field 5",
    "required": false,
    "is_global": true,
    "interpolation_html_encode": true,
    "interpolation_url_encode": true
  },
  "error_code": null,
  "error_message": null
}

List deleted custom fields

When a custom field is deleted, it is not actually removed from the database. Instead, it is marked as deleted and is no longer used.

This endpoint will return the list of deleted custom fields that were associated with the specified mailing list or organization.

URL

GET /ga/api/v2/mailing_lists/:mailing_list_id/custom_fields/deleted

GET /ga/api/v2/custom_fields/deleted

Response

The response will contain the same fields as is listed in the Attributes section above – but with one additional field deleted_at. This value will be the time at which the custom field was deleted.

Example

> GET /ga/api/custom_fields/deleted HTTP/1.1
> Authorization: Basic MTo5N2M3MDIyMWU0Yzk4NTg4NTY2ZTk5MjZjMzM1MmVmMWExYTIwNWJj
> Accept: application/json
> Content-Type: application/json

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "29cdc1ba8bf11b31f1d92d7eeaa7ad75"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: _session_id=2a40cddeda9a045b6487994258ca6e88; path=/; HttpOnly
< X-Request-Id: 24f9b05b55f07bbf985899c23c74b975
< X-Runtime: 0.574737
< Connection: close
< Server: thin 1.5.0 codename Knife

{
  "success": true,
  "data": [
    {
      "default_string": "",
      "deleted_at": "2015-03-17T21:02:22Z",
      "field_type": "text",
      "id": 6,
      "instructions": "",
      "mailing_list_id": null,
      "maximum_length": null,
      "minimum_length": null,
      "name": "Org Glo Field",
      "required": false,
      "is_global": true,
      "interpolation_html_encode": true,
      "interpolation_url_encode": true
    }
  ],
  "error_code": null,
  "error_message": null
}
 "Campaigns API"
"Jobs API"