Contact Fields

Define custom contact fields

Manage contact fields

Get all Contact Fields

get

Get all Contact Fields existing in your account

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Responses

200

OK.

application/json

idintegerOptional

namestring · max: 80Optional

data_typestring · enumOptionalPossible values:

merge_tagstring · max: 80Optional

Personalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

get/api/contacts/fields

cURLNode.jsPHPPythonRubyC#Java

curl -X GET https://mailtrap.io/api/contacts/fields \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

[
  {
    "id": 6730,
    "name": "First name",
    "data_type": "text",
    "merge_tag": "first_name"
  },
  {
    "id": 6731,
    "name": "Birthdate",
    "data_type": "date",
    "merge_tag": "birthdate"
  },
  {
    "id": 6732,
    "name": "Cats count",
    "data_type": "integer",
    "merge_tag": "cats_count"
  }
]

Create Contact Field

post

Create new Contact Fields. Please note, you can have up to 40 fields.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Body

application/json

namestring · max: 80Optional

data_typestring · enumOptionalPossible values:

merge_tagstring · max: 80Optional

Personalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.

Responses

201

Contact Field Created.

application/json

idintegerOptional

namestring · max: 80Optional

data_typestring · enumOptionalPossible values:

merge_tagstring · max: 80Optional

Personalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

422

Returns validation errors.

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

post/api/contacts/fields

cURLNode.jsPHPPythonRubyC#Java

curl -X POST https://mailtrap.io/api/contacts/fields \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Company", "data_type": "text", "merge_tag": "company"}'

{
  "id": 26730,
  "name": "My Contact Field",
  "data_type": "text",
  "merge_tag": "my_contact_field"
}

Get Contact Field

get

Get a contact Field by ID

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

field_idinteger · int64 · min: 1Required

Unique Contact Field ID

Example: 3229

Responses

200

Returns attributes of the contact field.

application/json

idintegerOptional

namestring · max: 80Optional

data_typestring · enumOptionalPossible values:

merge_tagstring · max: 80Optional

Personalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

get/api/contacts/fields/{field_id}

cURLNode.jsPHPPythonRubyC#Java

curl -X GET https://mailtrap.io/api/contacts/fields/{field_id} \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

{
  "id": 26730,
  "name": "My Contact Field",
  "data_type": "text",
  "merge_tag": "my_contact_field"
}

Delete Contact Field

delete

Delete existing Contact Field Please, note, you cannot delete a Contact Field which is used in Automations, Email Campaigns (started or scheduled), and in conditions of Contact Segments (you'll see the corresponding error)

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

field_idinteger · int64 · min: 1Required

Unique Contact Field ID

Example: 3229

Responses

204

Contact Field successfully deleted

No content

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

422

Returns validation errors.

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

delete/api/contacts/fields/{field_id}

cURLNode.jsPHPPythonRubyC#Java

curl -X DELETE https://mailtrap.io/api/contacts/fields/{field_id} \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

No content

Update Contact Field

patch

Update existing Contact Field. Please note, you cannot change data_type of the field.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

field_idinteger · int64 · min: 1Required

Unique Contact Field ID

Example: 3229

Body

application/json

namestring · max: 80Optional

merge_tagstring · max: 80Optional

Personalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.

Responses

200

OK.

application/json

idintegerOptional

namestring · max: 80Optional

data_typestring · enumOptionalPossible values:

merge_tagstring · max: 80Optional

Personalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

422

Returns validation errors.

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

patch/api/contacts/fields/{field_id}

cURLNode.jsPHPPythonRubyC#Java

curl -X PATCH https://mailtrap.io/api/contacts/fields/{field_id} \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Updated Name", "merge_tag": "updated_name"}'

{
  "id": 6730,
  "name": "Updated name",
  "data_type": "text",
  "merge_tag": "updated_name"
}