Gyfti API

Use the Gyfti API to connect external tools, automations, or customer systems with your Gyfti workspace.

The API is currently divided into two main sections:

API Portail

The Portail API helps you manage users from your portal.

You can use it to:

• Update a portal user’s information

• Assign or update a user segment

• Add or define user points

• Validate a challenge

This API is useful when you want to keep portal users synchronized with another system, such as a CRM, HR tool, or internal platform.

API Campaign

The Campaign API helps you add contacts to your Gyfti campaigns.

You can use it to:

• Retrieve a campaign identifier

• Add contacts to an existing campaign

• Send contact information required for digital or postal gifting campaigns

This API is useful when you want to send campaign contacts from another tool, such as a CRM, form, spreadsheet, or internal workflow.

---

Before using the API

Each API request must be authenticated with your Gyfti API key.

You can find your API key inside your Gyfti account.

---

Available API pages

• API Portal — manage portal users and validate challenges

• API Campaign — add contacts to campaigns