I/O Docs: API Documentation
Test VR's API using our interactive console. Refer to our API reference documentation for details on each API.
Service used in stage for OAuth 2.0
Service used in live for OAuth 2.0
-
Contacts
-
GET Get All Contacts /api/v1/contacts
-
POST Create A New Contact /api/v1/contacts
-
GET Search Contacts /api/v1/contacts
-
PUT Update Contact /api/v1/contacts/:contact_id
-
DELETE Delete Contact /api/v1/contacts/:contact_id
-
GET Read Contact /api/v1/contacts/:id
-
GET Contact : Member Lists /api/v1/contacts/:id/lists
-
GET Contact : Targeted Messages /api/v1/contacts/:id/messages
-
-
Lists
-
POST Create Lists /api/v1/lists
-
DELETE Delete Lists /api/v1/lists/:list_id
-
GET Read List /api/v1/lists/:list_id
-
GET Get All Lists /api/v1/lists
-
GET Targeted Messages /api/v1/lists/:list_id/messages
-
GET Lists:Member Contacts /api/v1/lists/:list_id/contacts
-
-
Emails
-
POST Create Email /api/v1/messages/emails
-
DELETE Delete Email /api/v1/messages/emails/:email_id
-
GET List All Emails /api/v1/messages
-
GET Read Email /api/v1/messages/emails/:email_id
-
POST Launch Email /api/v1/messages/emails/:email_id
-
POST Launch Test Email /api/v1/messages/emails/:email_id/test
-
POST Email: Get Summary Stats /api/v1/messages/emails/:email_id/stats
-
GET Email: Targeted Lists /api/v1/messages/emails/:email_id/lists
-
-
Social Posts
-
GET Social Posts: Get Summary Stats /api/v1/messages/social_posts/:socialpost_id/lists
-
-
Contacts
-
POST Create A New Contact /api/v1/contacts
-
PUT Update Contact /api/v1/contacts/:contact_id
-
GET Get All Contacts /api/v1/contacts
-
GET Contacts:Summary Stats /api/v1/contacts/:contact_id/stats
-
GET Search Contacts /api/v1/contacts
-
GET List Inactive Contacts /api/v1/contacts
-
GET List All Contact Attributes /api/v1/contacts/fields
-
GET Read Contact /api/v1/contacts/:id
-
GET Contact : Member Lists /api/v1/contacts/:id/lists
-
GET Contact : Targeted Messages /api/v1/contacts/:id/messages
-
DELETE Delete Contact /api/v1/contacts/:contact_id
-
-
Lists
-
POST Create List /api/v1/lists
-
PUT Update List /api/v1/lists/:list_id
-
POST Add Contact to a List /api/v1/lists/:list_id/contacts
-
GET Read List /api/v1/lists/:list_id
-
GET Get All Lists /api/v1/lists
-
GET List:Summary Stats /api/v1/lists/:list_id/stats
-
GET Targeted Messages /api/v1/lists/:list_id/messages
-
GET Lists:Member Contacts /api/v1/lists/:list_id/contacts
-
DELETE Delete Lists /api/v1/lists/:list_id
-
DELETE Remove Contact from List /api/v1/lists/:list_id/contacts/:contact_id
-
-
Messages
-
GET List Messages /api/v1/messages
-
GET Messages:Find /api/v1/messages
-
-
Emails
-
POST Create Email /api/v1/messages/emails
-
PUT Update Email /api/v1/messages/emails/:email_id
-
POST Launch Email /api/v1/messages/emails/:email_id
-
POST Launch Test Email /api/v1/messages/emails/:email_id/test
-
GET List Emails /api/v1/messages
-
POST Unschedule Email /api/v1/messages/emails/:email_id/unschedule
-
GET Read Email /api/v1/messages/emails/:email_id
-
GET Email: Get Summary Stats /api/v1/messages/emails/:email_id/stats
-
GET Email: Targeted Lists /api/v1/messages/emails/:email_id/lists
-
DELETE Delete Email /api/v1/messages/emails/:email_id
-
-
Custom Fields
-
POST Create Custom Field /api/v1/custom_fields
-
PUT Update Custom Field /api/v1/custom_fields/:custom_field_name
-
GET List all Custom Fields /api/v1/custom_fields
-
DELETE Delete Custom Field /api/v1/custom_fields/:custom_field_name
-
-
Social Posts
-
GET List Social Posts /api/v1/messages
-
GET Social Posts: Get Summary Stats /api/v1/messages/social_posts/:socialpost_id/stats
-