Complex Types
Below is a description of all complex types you'll encounter when using the CustomerBeach API.
Result
Most API functions will return a Result by default.
Code: integer
A status code other then 1 is an error/failure. Refer to the individual function documentation for all possible codes.
Message: string
The message is a brief description of the status code.
Contact
Encapsulates all data stored for a Contact.
Email: string
The email address for the contact.
ExtraFields: ContactExtraField[]
An array of type ContactExtraField, see below for a description.
Status: integer
The status code gives you the current state of the contact: 0 = the verification email has not yet been sent 1 = the verification email has been sent, we are now awaiting a reply 2 = the welcome message has not yet been sent 3 = Contact is Active 4 = Unsubscribed through web interface 5 = Contact Unsubscribed themselves 6 = Unsubscribed, soft bounce - too many in a row 7 = Unsubscribed, hard bounce - bad email address 8 = Deleted and thus Unsubscribed, but we still keep record 9 = Deleted because contact didn't click the link in the verification message 10 = Unsubscribed via the API
CreatedBy: string
Tells you were this contact got entered into your account. For example, import tool, website subscribe form, API, and etc.
SoftBounceCount: integer
The number of soft bounces this contact currently has. Remember that this counter is reset once a delivery can be confirmed. Too many soft bounces will result in an unsubscribe.
DateCreated: string
The Date and Time the contact was created in the system. The format of the date will be: MM/DD/YYYY HH:MM:SS TT
DateSubscribed: string
The Date and Time the contact was considered subscribed in the system. The format of the date will be: MM/DD/YYYY HH:MM:SS TT
DateUnSubscribed: string
The Date and Time the contact was unsubscribed in the system. The format of the date will be: MM/DD/YYYY HH:MM:SS TT
DateDeleted: string
The Date and Time the contact was deleted in the system. The format of the date will be: MM/DD/YYYY HH:MM:SS TT
ContactExtraField
Consists of a Key/Value pair. This is used to hold extra fields for the contact object. The full list of Keys can be found here.
Key: string
The Key is the name of the field for which you're submitting a value.
Value: string
The value for the above Key.