Force24 has an open API that your developers (or a third party tool) can use to build connections between Force24 and your other systems. This article gives a quick overview of what the API can do and how a master user can get set up with an API connection.
Full technical documentation for every endpoint lives on our API reference page: Swagger UI. This is where you can see each endpoint, what it needs, and what it returns.
What can the API do?
The current version is v1.3. Broadly speaking, it lets you:
- Manage contacts: find, create, update, upsert and delete contacts, and pull feeds of recently changed, deleted or erased contacts.
- Work with custom objects: set up custom objects and fields, then create and update object records against a contact.
- Manage Segments: create, rename and delete Segments, and add or remove contacts.
- Report on email and SMS: load campaign details and stats, sent items, opens, clicks, bounces and unsubscribes.
- Send single emails: trigger an API email campaign to an individual contact.
- Pull web activity: load on-site activity for identified contacts.
- Read supporting data: tags, subscription preferences and your contact field schema.
Good to know
Many of the reporting endpoints are feeds. You pass in a starting point (a version number or an offset) and a count, and each response tells you where to carry on from. The Swagger page explains how each one works.
How do I get to the Applications page?
API connections are managed from the Applications page. For security, this page is only available to the master user of your account.
- Log in to Force24 as the master user.
- Click the cog icon in the top right corner.
- Select Applications.
Can't see Applications?
The Applications page needs to be enabled on your account, and it can only be viewed by the Master User. If it isn't showing for your master user, speak to your account manager and they can get it added for you.
How do I add an API connection?
Once you're on the Applications page, the master user can see the existing API key and secret, or create a new connection:
- Click New application.
- Give the application a name, so you can tell what it's used for later.
- Choose whether the connection should have the Force24 API Master Role. Set it to Yes for master level access, or No for standard access.
- Save it. Force24 will generate a new API key and secret.
The key is shown on the page and the secret is hidden. Click the hidden secret, then choose Reveal or Copy. Your developer can then use the key and secret to connect.
Keep your secret safe
Your API secret works like a password. Only share it with people or systems that need it, and don't paste it into emails, support chats or public documents.
Connecting to the API
The API is served from the address below. Always use https, as secure communication is enforced.
https://api.data-crypt.comRelated articles
These articles cover related topics in more detail:
- To find your existing credentials, read How to find your Force24 API Key and Secret.
- To trigger an email to an individual contact, read How to send single emails via the API.
- To learn more about custom objects, read What are custom objects?.
- To see what changed in API security, read Force24 API Security Update.
Can't find what you need?
The Swagger page lists every endpoint that's currently available, so it's the best place to check whether something can be done through the API. If you can't find what you're after, email Force24 support at support@force24.co.uk which will open a support ticket for you, and the team can point you towards other options, such as reports available in the platform.