LYlytics
Schema Patches

Update, remove, or delete patch field

Changed on

Updates an existing field, removes a field from a patch (remove=true), or marks a field for deletion when the patch is applied (delete=true).

post/schema/patch/{table}/{id}/field/{field_id}

Request

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

Path parameters

tablestring required

Table name

idstring required

Patch ID

field_idstring required

Field ID

Query parameters

account_idstring

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

removeboolean

Remove field from patch (undo changes)

deleteboolean

Mark field for deletion when patch is applied

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

Updated patch with diff information

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Changes