Contacts

All messages sent in Notifuse are attached to contacts (= users). This way, we can keep track of which messages have been read by your users.

Every contact has its own profile, where you can store some data. The user profile data is then available in your templates as a user object (i.e: Hello {{ user.firstName }}).

Reserved fields

To improve & anticipate the future cool Notifuse features, some profile fields are reserved or have a specific format to respect if you want to use them.

All profile fields are optional, but you still have to specify the email address of your contacts if you want to email them!

Field

Type

Description

id

string

This field contains the your user ID.

firstName

string

First name of your contact. The firstName is displayed in the Notifuse UI.

lastName

string

Last name of your contact. The lastName is displayed in the Notifuse UI.

photoURL

string: URL

URL of an image. The photoURL is displayed in the Notifuse UI.

timezone

string: time zone name

Time zone name defined in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. The timezone field is used by Notifuse when you want to schedule your messages in the time zone of your contacts.

language

string: ISO 639-1 alpha2

Language code defined in ISO 639-1 alpha2 (two letters like "en", "fr"...).

country

string: ISO 3166-2

Country code defined in ISO 3166-2 (two uppercase letters).

The following fields are used by channels to route the messages:

Field

Type

Description

email

string: email

Email address of your contact, used by email channels. This field is displayed in the UI.

telephone

string

Mobile phone number of your contact, used by SMS channels, in international format (+44 123456789). This field is displayed in the UI.

{
"id": "xxxxx",
"firstName": "John",
"lastName": "Doe",
"timezone": "Europe/London",
"language": "en",
"country": "GB",
"photoURL" :"https://notifuse.com/images/item-photo.png"
}

Importing & updating contacts

You can initially import your CSV contacts list via the user interface, but it's recommended to implement the API in your app to keep it synced.

Via the API, there are 2 ways to sync your contacts, with users.upsert and while you send a message.If your contact doesn't exist yet, it will be automatically inserted, otherwise it's updated!