API Campagne
Add Contacts to Campaigns API
Use the Gyfti API to add contacts to your campaigns.
This API allows you to send gifts to your contacts via your Gyfti campaigns programmatically.
1. Retrieve the campaign ID
Before adding a contact to a campaign, you need to retrieve the campaign’s unique identifier.
Once the campaign has been published, open the campaign details page in Gyfti. You can find the campaign ID directly in the page URL.
The URL will follow this format:
https://app.gyfti.fr/v3_offreur?tab=campagnes&campaign={campaign_id}&sub=recapThe value after campaign= is the campaign ID.
For example:
https://app.gyfti.fr/v3_offreur?tab=campagnes&campaign=abc123&sub=recapIn this example, the campaign ID is:
abc1232. Add a contact to a campaign
Use this endpoint to add a contact to an existing campaign.
Endpoint
Headers
Get you API Key from your setting page
Request body
Parameters
campaign_id
string
Yes
The unique identifier of the campaign.
user_email
string
Yes
The email address of the user sending the gift.
contact_first_name
string
Yes
The contact’s first name.
contact_last_name
string
Yes
The contact’s last name.
contact_email
string
Yes
The contact’s email address.
contact_city
string
No
The contact’s city.
contact_postal_code
string
No
The contact’s postal code.
contact_country
string
No
The contact’s country.
contact_address
string
No
The contact’s address.
contact_phone
string
No
The contact’s phone number.
contact_additional_address
string
No
Additional address information for the contact.
contact_job_title
string
No
The contact’s job title.
Example request
Example response
Last updated