Create user

POST /v1/users

Creates a new user with the given data

application/json

Body Required

User data

identifyId string Required
type string

Values are LEAD, USER, VISITOR, or EMPTY_USER_TYPE.
gender string

Values are MALE, FEMALE, OTHER, or EMPTY_GENDER.
email string
firstName string
lastName string
signUpDate integer(int64)
firstVisitDate integer(int64)
title string
phone string
score integer(int64)
role string
subscriptionId string
accountId string
location object

Location object
Hide location attributes Show location attributes object
- countryName string
- countryCode string
  
  See ISO 3166
- stateName string
- stateCode string
  
  See ISO 3166
- city string
- street string
- postalCode string
- continent string
  
  See ISO 3166
- regionName string
  
  See ISO 3166-2
- timeZone string
- coordinates object
  
  Coordinates object
  Hide coordinates attributes Show coordinates attributes object
  
  latitude number(double)
  
  longitude number(double)
propertyKeys array[string] Required

Aptrinsic Tag Key, at least one is required
customAttributes object

Map of apiName to value
globalUnsubscribe boolean
sfdcContactId string
channelMetricList array[object]
Hide channelMetricList attributes Show channelMetricList attributes object
Channel metric object
- groupId string
- channel integer(int64)
- environment integer(int32)
- firstSeenDate integer(int64)
- lastSeenDate integer(int64)
lastVisitedUserAgentData array[object]
Hide lastVisitedUserAgentData attributes Show lastVisitedUserAgentData attributes object
User Agent data by product
- propertyKey string
- userAgent object
  
  User Agent object
  Hide userAgent attributes Show userAgent attributes object
  
  rawUserAgent string
  
  device string
  
  platformType string
  
  platformVersion string
  
  browserType string
  
  browserVersion string
lastInferredLocation object

Location object
Hide lastInferredLocation attributes Show lastInferredLocation attributes object
- countryName string
- countryCode string
  
  See ISO 3166
- stateName string
- stateCode string
  
  See ISO 3166
- city string
- street string
- postalCode string
- continent string
  
  See ISO 3166
- regionName string
  
  See ISO 3166-2
- timeZone string
- coordinates object
  
  Coordinates object
  Hide coordinates attributes Show coordinates attributes object
  
  latitude number(double)
  
  longitude number(double)

Responses

201 */*

Created User
Hide response attributes Show response attributes object
- body object
- statusCode string
  
  Values are 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, or 511.
- statusCodeValue integer(int32)
400

Bad request, possible duplicate
401

Unauthorized or bad API Key
429

Rate limit exceeded

POST /v1/users

curl \
 --request POST 'https://api.aptrinsic.com/v1/users' \
 --header "Content-Type: application/json" \
 --data '{"identifyId":"string","type":"LEAD","gender":"MALE","email":"string","firstName":"string","lastName":"string","signUpDate":42,"firstVisitDate":42,"title":"string","phone":"string","score":42,"role":"string","subscriptionId":"string","accountId":"string","location":{"countryName":"United States","countryCode":"USA","stateName":"California","stateCode":"CA","city":"San Mateo","street":"101 Broadway","postalCode":94010,"continent":"NA","regionName":"string","timeZone":"string","coordinates":{"latitude":37.567147,"longitude":-122.324211}},"propertyKeys":["AP-XXXXXXXXXX-2"],"customAttributes":{},"globalUnsubscribe":true,"sfdcContactId":"string","channelMetricList":[{"groupId":"string","channel":42,"environment":42,"firstSeenDate":42,"lastSeenDate":42}],"lastVisitedUserAgentData":[{"propertyKey":"string","userAgent":{"rawUserAgent":"string","device":"string","platformType":"string","platformVersion":"string","browserType":"string","browserVersion":"string"}}],"lastInferredLocation":{"countryName":"United States","countryCode":"USA","stateName":"California","stateCode":"CA","city":"San Mateo","street":"101 Broadway","postalCode":94010,"continent":"NA","regionName":"string","timeZone":"string","coordinates":{"latitude":37.567147,"longitude":-122.324211}}}'

Request examples

{
  "identifyId": "string",
  "type": "LEAD",
  "gender": "MALE",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "signUpDate": 42,
  "firstVisitDate": 42,
  "title": "string",
  "phone": "string",
  "score": 42,
  "role": "string",
  "subscriptionId": "string",
  "accountId": "string",
  "location": {
    "countryName": "United States",
    "countryCode": "USA",
    "stateName": "California",
    "stateCode": "CA",
    "city": "San Mateo",
    "street": "101 Broadway",
    "postalCode": 94010,
    "continent": "NA",
    "regionName": "string",
    "timeZone": "string",
    "coordinates": {
      "latitude": 37.567147,
      "longitude": -122.324211
    }
  },
  "propertyKeys": [
    "AP-XXXXXXXXXX-2"
  ],
  "customAttributes": {},
  "globalUnsubscribe": true,
  "sfdcContactId": "string",
  "channelMetricList": [
    {
      "groupId": "string",
      "channel": 42,
      "environment": 42,
      "firstSeenDate": 42,
      "lastSeenDate": 42
    }
  ],
  "lastVisitedUserAgentData": [
    {
      "propertyKey": "string",
      "userAgent": {
        "rawUserAgent": "string",
        "device": "string",
        "platformType": "string",
        "platformVersion": "string",
        "browserType": "string",
        "browserVersion": "string"
      }
    }
  ],
  "lastInferredLocation": {
    "countryName": "United States",
    "countryCode": "USA",
    "stateName": "California",
    "stateCode": "CA",
    "city": "San Mateo",
    "street": "101 Broadway",
    "postalCode": 94010,
    "continent": "NA",
    "regionName": "string",
    "timeZone": "string",
    "coordinates": {
      "latitude": 37.567147,
      "longitude": -122.324211
    }
  }
}

Response examples (201)

{
  "body": {},
  "statusCode": "100",
  "statusCodeValue": 42
}