Unions

CustomFieldSubjectType#

An object that can have custom fields applied to it.

union CustomFieldSubjectType = Company | Contact

Possible types#

NameDescription
Company A company represents an organization containing one or more contacts.
Contact A contact contains the personal information associated with someone you have interacted with using Groove. They are identified by some unique contact detail such as an email address, a Twitter handle, or a phone number. This depends on how the contact was created. A contact is often a customer who initated a conversation. It could also be someone who was copied in on a conversation.

LabelableTypes#

An object that can have labels applied to it.

union LabelableTypes = Company | Contact

Possible types#

NameDescription
Company A company represents an organization containing one or more contacts.
Contact A contact contains the personal information associated with someone you have interacted with using Groove. They are identified by some unique contact detail such as an email address, a Twitter handle, or a phone number. This depends on how the contact was created. A contact is often a customer who initated a conversation. It could also be someone who was copied in on a conversation.

ValueTypeUnion#

All possible custom field value types.

union ValueTypeUnion =
Address
| File
| IpAddress
| Link
| Session
| Text
| UserAgent

Possible types#

NameDescription
Address A full address.
File A file attached to a contact or company.
IpAddress An IP address.
Link A text link.
Session A contact visit session as recorded by the Widget.
Text A text string. It can represent either a single line, multiple lines, or an email.
UserAgent A characteristic string used to identify visitors.