Schema

Upsert a field in draft schema.

post/schema/{table}/field

Request

  • Base URL
    https://api.lytics.io/v2
  • URL
    https://api.lytics.io/v2/schema/{table}/field
  • Auth
    API key in header Authorization

Path parameters

tablestring required

The table (e.g. user)

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

Request body */*

capacityinteger

Specifies the capacity for fields of type set or map

createdstring date-time
disable_indexingboolean
edit_statusstring
idstring

ID, or name of field

is_identifierboolean
is_piiboolean
keep_daysinteger

TTL for fields of type set or map, in days

keep_durationstring

TTL for field of type set or map, must match keep_days if both are defined ie: 7d

longdescstring
managed_bystring
mergeopstring
modifiedstring
shortdescstring
tagsstring[]
typestring

Response

Field

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Changes