API

WebsiteAPI V1 - MailingPurposeInVerificationPrivate

Resource Details

URL: /WebsiteAPI/v1/MailingPurposeInVerificationPrivate/{purposeid}
Description: Private API resource which allows a user to view, add and update purposes while the contact is in verification
Call type: Entity
Filter:
Sort: SERIALNUMBER ASC, PURPOSE ASC
GET: Allowed - Requires Authentication
POST: Allowed - Requires Authentication
PUT: Not Allowed
DELETE: Not Allowed

Fields

Field Name Select By Default Filterable Sortable Postable Post Default Value Putable
emailConsentStatus -
Validation (Rule - Message):
  • Please enter a Status that exists in the system for the Email consent.
emailExpiry -
Validation (Rule - Message):
  • Must be a date - emailExpiry must be a valid date of format DD/MM/YYYY
emailModifiedBy -
emailNotes -
emailReceived -
Validation (Rule - Message):
  • Must be a date - emailReceived must be a valid date of format DD/MM/YYYY
emailSource -
Validation (Rule - Message):
  • Please enter a Source Code that exists in the system for the Email consent.
importId -
mailConsentStatus -
Validation (Rule - Message):
  • Please enter a Status that exists in the system for the Mail consent.
mailExpiry -
Validation (Rule - Message):
  • Must be a date - mailExpiry must be a valid date of format DD/MM/YYYY
mailModifiedBy -
mailNotes -
mailReceived -
Validation (Rule - Message):
  • Must be a date - mailReceived must be a valid date of format DD/MM/YYYY
mailSource -
Validation (Rule - Message):
  • Please enter a Source Code that exists in the system for the Mail consent.
modified -
modifiedBy -
phoneConsentStatus -
Validation (Rule - Message):
  • Please enter a Status that exists in the system for the Phone consent.
phoneExpiry -
Validation (Rule - Message):
  • Must be a date - phoneExpiry must be a valid date of format DD/MM/YYYY
phoneModifiedBy -
phoneNotes -
phoneReceived -
Validation (Rule - Message):
  • Must be a date - phoneReceived must be a valid date of format DD/MM/YYYY
phoneSource -
Validation (Rule - Message):
  • Please enter a Source Code that exists in the system for the Phone consent.
purpose -
Validation (Rule - Message):
  • Required Field - Please enter the Purpose for the consent.
  • Please enter a Purpose that exists in the system.
purposeId -
serialNumber -
Validation (Rule - Message):
  • Required Field - You must enter the serialNumber
  • Please enter a valid Serial Number.
smsConsentStatus -
Validation (Rule - Message):
  • Please enter a Status that exists in the system for the SMS consent.
smsExpiry -
Validation (Rule - Message):
  • Must be a date - smsExpiry must be a valid date of format DD/MM/YYYY
smsModifiedBy -
smsNotes -
smsReceived -
Validation (Rule - Message):
  • Must be a date - smsReceived must be a valid date of format DD/MM/YYYY
smsSource -
Validation (Rule - Message):
  • Please enter a Source Code that exists in the system for the SMS consent.