How to add contacts via a JSON request within your email body

Ratecard allows you to add contacts to your smart groups via an email message without using a vCard. You can use the JSON format to do this, and send a JSON request within your email body in order to add contact(s).

This is how it works:

Step 1: Copy the email address of the smart group you want to add contact(s) to

Send an email to the group ID email address you want to add the contact(s) to. You can find this address next to the smart group you want to add your new contact(s) to:

Step 2: Create an email to the smart group ID in JSON format

Add the contact data of the contact(s) you want to add to the email content. It is important to do this very precisely, otherwise the contact(s) might not be added correctly to your smart group.

Make sure you add at least the following information of your contact:

• First name
• Last name
• Email address and/or phone number  

If you add neither the telephone number nor the email address, it is impossible for us to process your requests and therefore to send out feedback requests.

Step 3: Parameters and their definitions

You can use the following parameters:

• firstname = first name of contact
• lastname = last name of contact
• email = email address of contact
• phone = phone number of contact
• DTSTART = the starting date and time of the meeting
• DTEND = the end date and time of the meeting
• DTOPTIN = optin date
• OPTINDAYS = optin days before deletion of contact - based on optin date and optin period, a delete date will be generated automatically (if delete date isn't available).
• DTDELETE = delete date. At this date the contact will be deleted. If you add this to a contact, this delete date will override the optin date and/or optin period (even if set within your Ratecard setting)

Example of JSON request with one contact sent via the email body or content that will be processed correctly:

beginratecard
[
{
"firstname": "Robbie",
"lastname": "Sakkers",
"email": "robbie@ratecard.io",
"phone": "+31612345678",
"external_id: "12345",
"external_type": "candidate",
"source": "ATS"
}
]
endratecard

Example of JSON request with multiple contact sent via the email body or content that will be processed correctly:

beginratecard
[
{
"firstname": "Robbie",
"lastname": "Sakkers",
"email": "robbie@ratecard.io",
"phone": "+31612345678"
"external_id: "12345",
"external_type": "candidate",
"source": "ATS"
},

{
"firstname": "Jeroen",
"lastname": "Sakkers",
"email": "jeroen@ratecard.io"
}
]
endratecard

Do you need to add meeting data to your JSON request? You can easily add the start and end date of your meeting as well.

Step 4: Final checks for a perfect implementation

• Make sure the " are straight and not in italics like this: "
• Divide all data fields with comma's
• If you add multiple contacts in one email, make sure you divide them with a comma as well (see example)
• Every contact is between these brackets: { ... }
• The complete body of the email needs to be between these brackets: [ ... ]
• The domain name(s) you're sending these emails from is/are added as (an) allowed domain name(s) for smart groups within your Ratecard settings (i.e. "domainname.com"), or leave this field empty to accept all domain names
• Parameters "firstname" and "lastname" are required, and we also need "email" or "phone" to be able to process the new contact(s)
• Parameter "firstname", "lastname" and "email" or "phone" need to be available for all contacts (!) within the request, otherwise none will be processed

Step 5: Test your implementation within Ratecard

Not sure whether you've implemented it correctly? Switch on the email alert for smart group import errors, so you'll be notified if something goes wrong. If your contact(s) is/are added correctly, it/these will show up in your smart group

That's it! Now you're good to go.