Skip to content

Instantly share code, notes, and snippets.

@lizardking8610
Created May 28, 2019 18:33
Show Gist options
  • Save lizardking8610/66826709ae704a749ce6ed4d5f324a81 to your computer and use it in GitHub Desktop.
Save lizardking8610/66826709ae704a749ce6ed4d5f324a81 to your computer and use it in GitHub Desktop.
Revinate API Documentation
Advanced Setup
For more advanced users, who may have web development resources, they can directly interface with the API and build to their own requirements. A developer would need to build the JSON elements and POST it to the endpoint provided. One way to familiarize with this is also to review how we did this in the sample via the HTML source and the JavaScript used within the sample described earlier.
End-point and Method
End-point: http://contact-api.inguest.com/api/add-contacts-to-lists
Method: POST
Sample Usage
Here's an example of the raw JSON used to make the call:
Here's an example of the raw JSON passed back as a response:
Sample command using curl
curl -XPOST "http://contact-api.inguest.com/api/add-contacts-to-lists" -H "Content-Type:text/plain" -d '{"tokens":["GUID to be replaced"],"contacts":[{"first_name":"John","last_name":"Smith","address_1":"1 Letterman Dr","address_2":"","city":"San Francisco","state":"CA","country":"USA","zip":"94129","phone":"4155551212","em ail":"[email protected]"}]}'
Breaking down the above, you can see that the end-point is being called. The JSON elements include the following:
An array of (one or more) tokens: tokens correspond to an encrypted identifier for a given account's contact list(s) (REQUIRED)
An array of (one or more) contacts:
first_name
last_name
address_1
address_2 § city
state
country
zip
phone
email (REQUIRED)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment