Profiles

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Line 8: Line 8:
|-
|-
| [[Create profile]]
| [[Create profile]]
-
| POST /v1/{apikey}/profiles
+
| POST
 +
| /v1/{apikey}/profiles
|-
|-
| [[Fetch profile by key]]
| [[Fetch profile by key]]
-
| GET /v1/{apikey}/profile({key})/{value}
+
| GET
 +
| /v1/{apikey}/profile({key})/{value}
|-
|-
| [[Fetch profile]]
| [[Fetch profile]]
-
| GET /v1/{apikey}/profile/{uid}
+
| GET
 +
| /v1/{apikey}/profile/{uid}
|-
|-
|}
|}

Revision as of 15:30, 6 April 2011

API Home Page

A profile holds a single consumer's information. It consists of a collection of key:value pairs (fields) where each key is unique within the profile. Much of the information within the profile is considered private or PII and will not be shared with an untrusted client.

Create profile POST /v1/{apikey}/profiles
Fetch profile by key GET /v1/{apikey}/profile({key})/{value}
Fetch profile GET /v1/{apikey}/profile/{uid}

Required Fields

  • One primary key field to identify a consumer. This key is called {promokey} in the API documentation.

Standard Fields

These are fields that are typically collected for a promotion. The specific field names will be agreed upon during creation of the API Key.

  • first_name
  • last_name
  • age
  • address1
  • address2
  • address3
  • city
  • state
  • zip
  • country
  • locale
Personal tools