Merge Fields

When creating an activity with correspondence (currently letter, email), merge fields can be utilized to insert data about the acitivity, yourself, your company and so forth.

The format of the fields that can be inserted into a correspondence is the following:

Without default: {{merge_field_name}}

With default: {{merge_field_name|Unknown name}}

If the content for the merge field for some reason can't be found, the default value is used instead.

When using merge fields with the email correspondence type, the merge fields are replaced at the point of sending the mail, so if you queue an activity for later, the fields values will be rendered at that time.

List Merge Fields

GET /merge-fields

This simply returns an array of the fields that can be used.

Response
Status code 200

[
  "account.fixed_fields_name",
  "account.fixed_fields_address",
  "account.fixed_fields_zip_code",
  "account.fixed_fields_city",
  "account.fixed_fields_state_region",
  "account.fixed_fields_country",
  "account.fixed_fields_vat",
  "account.fixed_fields_website",
  "account.custom_fields_multiple_choice",
  "account.custom_fields_single_choice",
  "account.custom_fields_boolean",
]