Contacts
Overview
Create and edit contact information for customers and partners.
Contacts contain information for additional people to act as a point of communication. Add contact information such as name, role, email, and phone number to provide another connection for your specific need.
This object is only available within customers and partners as a connected object. All contacts are specific to a module and aren’t shared at the broader organization level. For a broker, contacts can also be created and assigned when sending the rate-confirmation with partners through Rose Rocket
Partner objects also contain a primary contact attribute for contacts. This defaults to the first contact within the list as well as can be assigned.
API configuration
When using the API to make requests, see the pages below for the process. These guides walk through the requirements and setup to access the Rose Rocket API with your application.
- Authentication - Access Rose Rocket with OAuth 2.0
- Object operations - Configure your requests
Object structure
Use the table below for information about the contact objects.
Fields | Label | Type | Description |
---|---|---|---|
fullId | Full ID | string | ID used to identify record as seen by user |
firstName | First Name | string | First name of contact |
lastName | Last Name | string | Last name of contact |
email | string | Email of contact | |
phone | Phone | string | Phone number of contact |
name | Full Name | string | First and last name of contact NOTE: This field is derived from the firstName , and lastName attributes.*See Read-only fields. |
dateCreatedLabel | Contact Date | date | Contact created date as a label string NOTE: This field is derived from the $createdAt?.toLocaleString() attribute.*See Read-only fields. |
isPrimary | Is Primary | Boolean | Status of primary contact or not when associated to another object |
status | Status | string, enumerated | Status of contact |
contactRole | Contact Role | string, enumerated | Role of contact |
customer | Customer | Customer connected object *See Connected object section | Customer associated with contact |
partner | Partner | Partner connected object *See Connected object section | Partner associated with contact |
formattedContact | Formatted Contact | string | Formatted contact field with summarized contact info blob NOTE: This field is derived from the firstName , lastName , phone , and email attributes.*See Read-only fields. |
Updated about 1 month ago