Skip to content
English
Log in to iluminr
  • There are no suggestions because the search field is empty.

Get to know the Contacts API integration

iluminr has the ability to be linked to a contact management systems currently in place in your organisation.

The iluminr Contacts API enables you to build an automated pipeline that syncs contact data from your source systems into iluminr.

You can integrate with platforms such as your HRS/HCM system, Active Directory, or third-party applications - or combine multiple sources into a single workflow. Updates run at a frequency you define, and the API supports creating, updating, and removing contacts.

When to use the Contacts API integration

  • Your contact data lives across multiple systems

  • You need to sync phone numbers and other rich contact fields for mass notifications (SMS, voice)

  • You require updates and deactivations — not just new contact creation

  • You have technical resources available to build and maintain the integration

  • You need precise control over data mapping and sync logic

Key benefits of Contacts API integration

  • Automated data synchronisation from your chosen source(s) of truth

  • Accurate and up-to-date contact records for staff and key stakeholders

  • Support for mass notifications, ensuring critical messages reach the right people

  • Reduced manual effort through scheduled, automated updates

People join, leave, and change roles within your organisation all the time. Without automation, contact data can quickly become outdated.

Keeping contact data current ensures you have the right information available when it matters most - including names, job titles, email addresses, mobile numbers, locations, and business group details. With the iluminr Contacts API integration you can manage what contact details are regularly updated without manual intervention at a preferred frequency.

Automating this process provides confidence that your important message is going to the right people at the time of sending. Learn more about Notifying Contacts with iluminr.

 

Setup is guided by the iluminr Customer Success team, who will validate your data types, formats, and test the integration in a UAT environment before go-live.

How do I setup the Contacts API in iluminr?

  1. Identify the source of truth, for all your contact information in your organisation (Active Directory, HRS/HCM platform or other data source)

  2. Meet with the iluminr Customer Success Team to validate data types, formats, frequency of updates and to establish your temporary test instance (UAT environment)

  3. Once validated set your production go live.

  4. Automated! Your contact data will now update automatically at your chosen frequency.

Ready to start? Connect with your Customer Success Manager.

Information to support your validation and testing of the Contacts API

contacts_api_diagram(2)

Available API Operations

Related Articles:

Need more assistance? Submit a support ticket