Examples

Add user example@example.com to a list called All Users

POST
{"id":"example@example.com",
 "key":"email",
 "lists":{"All Users":1}
}

Get current keys, engagement, activity information for a user whose SMS number is +15551234567

GET
{"id":"+15551234567",
 "key":"sms",
 "fields":{"keys":1,"engagement":1,"activity":1}
}

Set the email address of the user with Sailthru ID 4e2879472d7acd6d97144f9eto example@example.com

POST
{"id":"4e2879472d7acd6d97144f9e",
 "key":"sid",
 "keys":{"email":"example@example.com"}
}

Change an email address of a user by referencing a Sailthru ID (sid), using the 'keysconflict' parameter

POST
{"id":"4e2879472d7acd6d97144f9e",
"key":"sid",
"keys":{"email":"example@example.com"},
"keysconflict":"merge"
}

Change an email address using the 'keysconflict' parameter

POST
{"id":"emailtobeoverwritten@domain.com","key":"email","keysconflict":"merge","keys":{"email":"newemail@domain.com"}}

To set the Horizon cookie on a subscriber when they sign in to your site.

a) Record that your user id ABC123 has just logged in on your main site b) and return the keys, which includes the cookie you can set on the user. This is included in the code below. 

JSON

POST
{"id":"joe@example.com",
 "login":{"site":"main","ip":"127.0.0.1","user_agent":"Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1A543a Safari/419.3"},
 "fields":{"keys":1}
}

PHP

$result = $sailthru->apiPost('user', array(
   'id' => 'joe@example.com',
   'fields' => array('keys' => 1),
   'login' => array(
     'site' => 'example.com',
     'ip' => $_SERVER['REMOTE_ADDR'],
     'user_agent' => $_SERVER['HTTP_USER_AGENT'])
));
setcookie('sailthru_hid', $result['keys']['cookie']);

Ruby

{:id => 'joe@example.com',
:login => {
    :site => 'main',
    :ip => '127.0.0.1',
    :user_agent => 'Mozilla/5.0 (Iphone; U; CPU like Mac OS x; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1A543a Safari/419.3'},
:fields => {'keys' => 1}
}
response = sailthru.api_post('user', {
  :id => 'joe@example.com',
  :fields => {:keys => 1},
  :login => {
    :site => 'example.com',
    :ip => '127.0.0.1',
    :user_agent => 'place user agent here'
  }
})
cookies['sailthru_hid'] = {
  :domain => ".example.com",
  :value => response['keys']['cookie'],
  :expires => 3.months.from_now
}

# cookies[:key] is specific to Ruby on Rails