Skip to main content
Server path: /mailtrap-contacts | Type: Application | PCID required: Yes

Tools


mailtrap_contacts_contact_fields

Get all Contact Fields Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID

mailtrap_contacts_contact_lists

Get all Contact Lists Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID

mailtrap_contacts_create_contact

Create a new Contact Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
contactobjectYesThe contact value

mailtrap_contacts_create_contact_event

Create contact event Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
contact_identifierstringYesContact UUID or Email
namestringNoThe name value
paramsobjectNoA hash of string keys and scalar JSON values

mailtrap_contacts_create_contact_export

Create Contact Export Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
filtersany[]NoArray of filters to apply to the search

mailtrap_contacts_create_contact_field

Create Contact Field Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
data_typestringNoData Type
merge_tagstringNoPersonalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.
namestringNoThe name value

mailtrap_contacts_create_contact_list

Create Contact List Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
namestringNoThe name value

mailtrap_contacts_delete_contact

Delete contact Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
contact_identifierstringYesContact UUID or Email

mailtrap_contacts_delete_contact_field

Delete Contact Field Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
field_idintegerYesUnique Contact Field ID

mailtrap_contacts_delete_contact_list

Delete Contact List Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
list_idintegerYesUnique list ID

mailtrap_contacts_get_contact

Get contact Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
contact_identifierstringYesContact UUID or Email

mailtrap_contacts_get_contact_export

Get Contact Export Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
export_idintegerYesUnique Contact Export ID

mailtrap_contacts_get_contact_field

Get Contact Field Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
field_idintegerYesUnique Contact Field ID

mailtrap_contacts_get_contact_import

Get Contact Import Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
import_idintegerYesUnique Contact Import ID

mailtrap_contacts_get_contact_list

Get Contact List Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
list_idintegerYesUnique list ID

mailtrap_contacts_import_contacts

Import contacts Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
contactsobject[]NoThe contacts value

mailtrap_contacts_update_contact

Update contact Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
contact_identifierstringYesContact UUID or Email
contactobjectYesThe contact value

mailtrap_contacts_update_contact_field

Update Contact Field Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
field_idintegerYesUnique Contact Field ID
merge_tagstringNoPersonalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.
namestringNoThe name value

mailtrap_contacts_update_contact_list

Update Contact List Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
list_idintegerYesUnique list ID
namestringNoThe name value