PATCH api/v1/Contacts/{id}

Will patch contact object with given values. Only updates contact properties that are not null in patchContactDto. All other properties are left unchanged. NOTE: The following properies will be set to null if the patch value is "" (empty string): PhoneCountryCode, Phone and Email

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id of contact to update	integer	Required

Body Parameters

Partial contact information object

PatchContactDto

Name	Description	Type	Additional information
Version	Concurency check attribute used by database engine. Pass this value to update contact object when performing PUT (update) or PATCH (partial update) action.	Collection of byte	Required
Email	New email, null is interpreted as not changed.	string	String length: inclusive between 0 and 250
PhoneCountryCode	New Phone country code, null is interpreted as not changed.	string	String length: inclusive between 0 and 10
Phone	New Phone, null is interpreted as not changed.	string	String length: inclusive between 0 and 20
FirstName	New First Name, null is interpreted as not changed.	string	String length: inclusive between 0 and 50
LastName	New Last Name, null is interpreted as not changed.	string	String length: inclusive between 0 and 50
LimitMailsPermanently	New Limit Mails Permanently, null is interpreted as not changed.	boolean	None.
LimitMailsTemporarilyUntil	New Limit Mails Temporarily Until, null is interpreted as not changed.	date	None.
ProfileLastUpdated	New Profile Last Updated, null is interpreted as not changed.	date	None.
PreferredStoreId	New Preferred Store Id, null is interpreted as not changed.	integer	None.
ContactCompanyId	New ContactCompany Id, null is interpreted as not changed.	integer	None.
NewPassword	New Password for contact, null is interpreted as as password should not be changed.	string	None.
LatestPermissionSource	Source that was specified when latest permission was set.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Version": "QEA=",
  "Email": "sample string 1",
  "PhoneCountryCode": "sample string 2",
  "Phone": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "LimitMailsPermanently": true,
  "LimitMailsTemporarilyUntil": "2024-11-21T06:45:32.6938828+00:00",
  "ProfileLastUpdated": "2024-11-21T06:45:32.6938828+00:00",
  "PreferredStoreId": 1,
  "ContactCompanyId": 1,
  "NewPassword": "sample string 6",
  "LatestPermissionSource": "sample string 7"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Updated contact

ReadContactDto

Name	Description	Type	Additional information
Id	Id of contact uniquely identifying withing database.	integer	None.
Secret	Contact secret that uniquely identifies contact without disclosing any of its private information that is hard to guess. Used for example in links to identify which contact clicked the link. http://example.com/?s={Secret}	string	Required
RegistrationDateTime	Date and time of contact registration	date	Required
RegistrationSource	Registration source that was specified when creating contact	string	Required String length: inclusive between 0 and 50
RegistrationIp	Registration IPv4 address that was specified when creating contact	string	Required String length: inclusive between 0 and 16
LastModified	Date and time of last modification of contact in database	date	Required
Version	Concurency check attribute used by database engine. Pass this value to update contact object when performing PUT (update) action.	Collection of byte	Required
RegistrationStoreId	Store responsible for creating the contact	integer	None.
Email	Contact Email, must be unique within account	string	String length: inclusive between 0 and 250
PhoneCountryCode	Contact Phone country code, must not be included in Phone	string	String length: inclusive between 0 and 10
Phone	Contact Phone, must be unique withn account	string	String length: inclusive between 0 and 20
FirstName	First name of contact	string	String length: inclusive between 0 and 50
LastName	Last name of contact	string	String length: inclusive between 0 and 50
LimitMailsPermanently	Limit sending of emails to contact permanently	boolean	None.
LimitMailsTemporarilyUntil	Limit sending of emails to contact temporarily until specified date and time	date	None.
PreferredStoreId	Id of preferred store	integer	None.
ContactCompanyId	ContactCompanyId if the Contact is associated with a Company. Null if the contact is not associated with a ContactCompany	integer	None.
LatestPermissionSource	Source that was specified when latest permission was set.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Secret": "sample string 2",
  "RegistrationDateTime": "2024-11-21T06:45:32.6938828+00:00",
  "RegistrationSource": "sample string 4",
  "RegistrationIp": "sample string 5",
  "LastModified": "2024-11-21T06:45:32.6938828+00:00",
  "Version": "QEA=",
  "RegistrationStoreId": 1,
  "Email": "sample string 7",
  "PhoneCountryCode": "sample string 8",
  "Phone": "sample string 9",
  "FirstName": "sample string 10",
  "LastName": "sample string 11",
  "LimitMailsPermanently": true,
  "LimitMailsTemporarilyUntil": "2024-11-21T06:45:32.6938828+00:00",
  "PreferredStoreId": 1,
  "ContactCompanyId": 1,
  "LatestPermissionSource": "sample string 13"
}