Class UpdateContactRequest

Namespace

Mailtrap.Contacts.Requests

Assembly

Mailtrap.Abstractions.dll

Request object for updating a contact.

public sealed record UpdateContactRequest : ContactRequest, IValidatable, IEquatable<ContactRequest>, IEquatable<UpdateContactRequest>

Inheritance

object

ContactRequest

UpdateContactRequest

Implements

IValidatable

IEquatable<ContactRequest>

IEquatable<UpdateContactRequest>

Inherited Members

ContactRequest.Email

ContactRequest.Fields

ContactRequest.Validate()

Constructors

UpdateContactRequest(string)

Primary instance constructor.

public UpdateContactRequest(string email)

Parameters

email string

Email of the contact.

Remarks

Contact's email must be min 2 characters and max 100 characters long.

Exceptions

ArgumentNullException

When email is null or Empty.

Properties

ListIdsExcluded

Gets contact list IDs to exclude.

[JsonPropertyName("list_ids_excluded")]
public IList<int> ListIdsExcluded { get; }

Property Value

IList<int>

Contact list IDs to exclude.

ListIdsIncluded

Gets contact list IDs to include.

[JsonPropertyName("list_ids_included")]
public IList<int> ListIdsIncluded { get; }

Property Value

IList<int>

Contact list IDs to include.

Unsubscribed

Gets contact "unsubscribed" status.

[JsonPropertyName("unsubscribed")]
public bool? Unsubscribed { get; set; }

Property Value

bool?

Contact "unsubscribed" status.