Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference
GitHubDev CommunityOptimizely AcademySubmit a ticket

Optimizely developer documentation

How can we help you?

Try our conversational search powered by Generative AI!

AI OnAI Off

Create field

Create a field on an object in Optimizely Data Platform (ODP).

Log in to see full request history

📘

Note

If you are attempting to create an identifier, for example, an address for messaging or an internal reference to a customer record similar to an email, phone number, or token, see the Identifier API documentation.

When creating a field, you can control which Optimizely Data Platform (ODP) users can access it by setting it as personally identifiable information (PII). Do this using the PII object in the access_policies object:

  • enable – Set to true to make the data in that field accessible only to users with the PII Viewer role. Users without the PII Viewer role cannot access it and instead see a confidential label in place of the PII data. Set to false to let all ODP users access the data in that field.
  • suggestible – Set to true to let users without the PII Viewer role access the data for that field as suggestions in ODP features like segment building. Set to false to fully restrict access to the data in that field to only users with the PII Viewer role.

For more information, see the Manage PII in ODP user documentation.

Path Params
string
required

The name of the object.

Body Params
string
required

The name of the field (for example, ticket_id).

string
required

The human-readable name of the field (for example, Ticket ID).

boolean
Defaults to false

Enable access with the API public key.

description
array of strings

Detailed description of the field's purpose.

description
string
required

An array of relations field data type. Options are number, timestamp, string, boolean.

access_policies
object

Set access policies, like PII, for the field.

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json