Create identifier

1 min

POST

https://api.us1.odp.optimizely.com/v3/schema/identifiers

Create an identifier in Optimizely Data Platform (ODP) to use for user resolution.

Body Parameters

bodyIdentifierrequired
Examples
Example Payload:
{ "name": "facebook_messenger_id", "display_name": "Facebook Messenger ID", "public_read": false, "merge_confidence": "high", "messaging": true }
- namestringrequired
  Description
  The field name of the identifier, ending with one of the known suffixes: id, hash, number, token, alias, address, key.
- display_namestringrequired
  Description
  The human-readable name, ending with the title case version of the name suffix: ID, Hash, Number, Token, Alias, Address, Key.
- public_readboolean
  Description
  Enable access with the API public key.
  Default
  false
- merge_confidencestringrequired
  Description
  The level of confidence (high or low) that this identifier can be used to merge customer profiles together.
- messagingboolean
  Description
  Whether this identifier can be used to message customers in campaigns.

Responses

201Created

IdentifierCreated

Example

{
  "events": [
    {
      "name": "event_facebook_messenger_id",
      "display_name": "Event Facebook Messenger ID",
      "type": "identifier"
    }
  ],
  "customers": [
    {
      "name": "facebook_messenger_id",
      "display_name": "Last Seen Facebook Messenger ID",
      "type": "identifier"
    }
  ]
}

eventsobject[]
- namestring
  Example
  event_facebook_messenger_id
- display_namestring
  Example
  Event Facebook Messenger ID
- typestring
  Example
  identifier
customersobject[]
- namestring
  Example
  facebook_messenger_id
- display_namestring
  Example
  Last Seen Facebook Messenger ID
- typestring
  Example
  identifier

400Bad Request

Error

Example

{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-08-07T13:44:17.659Z",
  "detail": {
    "invalids": [
      {
        "field": "customers.name",
        "reason": "already used by another object"
      },
      {
        "field": "customers.display_name",
        "reason": "already used by another object"
      }
    ]
  }
}

titlestring
Example
Bad Request
statusinteger
Example
400
Default
0
timestampstring
Example
2018-08-07T13:44:17.659Z
detailobject
- invalidsobject[]
  - fieldstring
    Example
    name
  - reasonstring
    Example
    already used by another object

403Forbidden

curl

curl --request POST \
     --url https://api.us1.odp.optimizely.com/v3/schema/identifiers \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "name": "",
     "display_name": "",
     "merge_confidence": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "name": "",
   "display_name": "",
   "merge_confidence": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.us1.odp.optimizely.com/v3/schema/identifiers", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.us1.odp.optimizely.com/v3/schema/identifiers")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "name": "",
   "display_name": "",
   "merge_confidence": ""
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.us1.odp.optimizely.com/v3/schema/identifiers"

payload = json.dumps({
   "name": "",
   "display_name": "",
   "merge_confidence": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Created
{
  "events": [
    {
      "name": "event_facebook_messenger_id",
      "display_name": "Event Facebook Messenger ID",
      "type": "identifier"
    }
  ],
  "customers": [
    {
      "name": "facebook_messenger_id",
      "display_name": "Last Seen Facebook Messenger ID",
      "type": "identifier"
    }
  ]
}

400

// Bad Request
{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-08-07T13:44:17.659Z",
  "detail": {
    "invalids": [
      {
        "field": "name",
        "reason": "already used by another object"
      }
    ]
  }
}

403

// Forbidden