Contacts

Overview

The Contacts API allows you to manage contact departments within the platform. You should think of a contact as a department or group, such as Human Resources, Safety, or Dispatch, rather than an individual person. Users receive messages from and send messages to these contacts within the mobile app.

How It Works

The Contacts API integrates directly with your messaging system to route communications appropriately. The platform exposes endpoints that allow you to list, retrieve, and create or update contacts.

Defining Departments: You create a contact for each department that you wish to expose to users in the mobile app.
Message Routing: When users select a contact to send a message, the platform includes the contact_code in the inbound message. Your backend system uses this code to route the message to the appropriate contact within that department.
Displaying Sender Details: For outbound messages, you supply a contact_code so the mobile app displays the department as the sender.

Key Components

When you use the Contacts API, you will work with the following core items.

Code: This is the unique identifier you assign to each contact to identify and reference the contact.
Name: This property represents the name of the contact that displays to users at the top of the message UI in the mobile app.
Display When Sending: This boolean property determines whether the contact is available for users to select when they send a new message. If false, then the user will not see this contact in the list of available contacts when sending messages.