Sign in

v1

latestOpenAPI 3.0.02026-07-1427437.7 KB
Schemas

Create or update profile schema

Creates or updates profile schema.

Each account has one profile schema. Updating it with this request will substitute the previous version.

Learn more about the Profile System and its other API endpoints.

put/api/storage/profile-system/profiles/schema

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

descriptionstring required

Schema's human readable description.

documentTTLinteger

Document time to live, in days. After this many days from its creation or update, any document cerated from this schema will be deleted.

requiredstring[] required

Schema required fields.

titlestring required

Schema title.

typestring required

Schema type.

versioninteger

Schema version.

Example request

{
  "description": "This schema describes a b2c customer profile.",
  "documentTTL": 1825,
  "properties": {
    "{fieldName}": {
      "items": {
        "type": "string"
      },
      "pii": true,
      "sensitive": true,
      "type": "string"
    }
  },
  "required": [
    "firstName",
    "lastName",
    "email",
    "document",
    "documentType"
  ],
  "title": "Client profile schema",
  "type": "object",
  "v-indexed": [
    "email",
    "document"
  ],
  "v-unique": [
    "email",
    "document"
  ],
  "version": 1
}

Response

Created

object required