Package io.mailtrap.api.contactfields

Interface ContactFields

All Known Implementing Classes:
ContactFieldsImpl
public interface ContactFields

  • Method Details

    • getAllContactFields

      List<ContactFieldResponse> getAllContactFields(long accountId)
      Get all Contact Fields existing in your account
      Parameters:
      accountId - unique account ID
      Returns:
      existing contact fields

    • createContactField

      ContactFieldResponse createContactField(long accountId, CreateContactFieldRequest request)
      Create new Contact Fields (up to 40)
      Parameters:
      accountId - unique account ID
      request - contact field data
      Returns:
      attributes of the created contact field

    • getContactField

      ContactFieldResponse getContactField(long accountId, long fieldId)
      Get Contact Field by id
      Parameters:
      accountId - unique account ID
      fieldId - Unique Contact Field ID
      Returns:
      attributes of the contact field

    • updateContactField

      ContactFieldResponse updateContactField(long accountId, long fieldId, UpdateContactFieldRequest request)
      Update existing Contact Field
      Parameters:
      accountId - unique account ID
      fieldId - Unique Contact Field ID
      request - update data. You cannot change data_type of the field
      Returns:
      attributes of the contact field

    • deleteContactField

      void deleteContactField(long accountId, long fieldId)
      Delete existing Contact Field. You cannot delete a Contact Field which is used in Automations, Email Campaigns, and in conditions of Contact Segments
      Parameters:
      accountId - unique account ID
      fieldId - Unique Contact Field ID