Skip to content

Instantly share code, notes, and snippets.

@Tang8330
Last active December 1, 2016 20:11
Show Gist options
  • Save Tang8330/0188999b7cf750bd218531e002d5df42 to your computer and use it in GitHub Desktop.
Save Tang8330/0188999b7cf750bd218531e002d5df42 to your computer and use it in GitHub Desktop.
Outbound.io Privacy API Documentation

#Overview This is the specifications of how to get a Privacy API company up and running with better performance. This will also empower them to be able to have access to:

  • User Search
  • Faster Broadcast

##Specifications

  • Some SQL instance that will allow us to hold a steady DB connection via a SQL driver.
  • We should be able to connect via connection string (this will sit in Company Settings, and be available for them to edit on the Front End)
    • Outbound will only need READ-ACCESS
  • Some privacy API companies may also want to use private IP, and have us connect via VPN first (TO BE SCOPED W/ WHEELY)

##Schema

Column Name Column Type
user_id varchar (UQ, PK, NOT-NULL)
first_name varchar (NULLABLE)
last_name varchar (NULLABLE)
email varchar (NULLABLE)
phone_number varchar (NULLABLE)
timezone varchar (NULLABLE)
custom_attribute_a custom_type
custom_attribute_b custom_type
custom_attribute_c custom_type

What is marked in bold is fixed, as they are Outbound's Top-Level Attributes. The column MUST be present, however only user_id needs to be populated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment