API Reference

Metadata field syntax

In many cases, you can update a field in a DataTable call simply by using its API name. For example, you can rename an asset with the following call:

POST or GET /API/DataTable/V2.2/Documents.Folder.Default:Update?CoreField.Identifier=ZZ13U2O&CoreField.Title:=January photoshoot

In this example, CoreField.Title is the field to update, := is the operator, and January photoshoot is the new field value.

In the other cases, you’ll need to use a specific syntax to incorporate more data about the field you’re updating. Some commonly used field types are detailed below.

Inherited fields

Inherited fields are read-only. You cannot change the value of an inherited field with a DataTable API call.

Only the value of the original field – the value that other fields inherit – can be changed. The original field is identified with the <BaseField> attribute.

Related value fields

Related value fields are read-only. You cannot change the value of a related value field with a DataTable API call.

Only the value of the original field – the value that the related value field reflects – can be changed.

Multivalued fields

Use pipes ( | ) to separate values.

Example:

/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords++=River Thames|Tower of London|England

Paired value fields

Enter a value from an authority list, indicate the type of pairing in the paired value field, and then enter one of the following: another value from an authority list, a string of text, or a linked field’s record ID. The information you enter uses this structure:

[paired-value field’s API name][operator][authority list value]{"type of paired value field":"[value in the second authority list, free text, or the linked field’s record ID]"}

There are three types of paired value fields:

  • Two authority lists: Use "LinkedKeyword" to identify this type of paired value field.
  • An authority list and free text: Use "LinkedText" to identify this type of paired value field.
  • An authority list and a linked field: Use "LinkedField" to identify this type of paired value field.

Example:

/API/v2.2/DataTable/Documents.Image.Product-Photo:CreateOrUpdate?CoreField.Identifier=ZZ1428I&products.Marketing-campaign++=Create Your Dream Home{"LinkedKeyword":"Mango Atelier"}

Go to Update paired value fields to see more examples.

Date fields

Some types of date fields are read-only. Editable date fields can be updated with DataTable API calls using the name of the field and a date and time value following the ISO 8601 standard of yyyy-mm-ddThh:mm:ss, where T represents time, which is optional.

Example:

/API/V2.2/DataTable/Documents.Image.Default:Update?CoreField.Identifier=ZZ1428I&CoreField.SensitiveUntil:=2025-08-23

Computed date fields

Computed date fields are read-only. You cannot change a computed date with a DataTable API call.

Examples of computed dates include:

  • Creation Date (CoreField.CreateDate)
  • Digitized Date (CoreField.DigitizedDate)
  • Edited Date (CoreField.EditDate)
  • File Create Date (CoreField.FileCreateDate)
  • File Edit Date (CoreField.FileEditDate)
  • File Import Date (CoreField.FileImportDate)
  • Proxy Import Date (CoreField.ProxyImportDate)

Workflow date fields

Workflow date fields are editable. Update workflow date fields using the API name of the date field.

Example:

/API/V2.2/DataTable/Documents.Project.Standard-Project:Update?CoreField.Identifier=ZZ1428I&CoreField.LastStatusDate:=2025-08-23

Examples of workflow dates include:

  • Start Date (CoreField.StartDate)
  • End Date (CoreField.EndDate)
  • Last Status Update Date (CoreField.LastStatusDate)

Advanced date fields

All advanced date field types are editable. Update advanced date fields using a slash (/) and “NA” where needed to indicate unfilled date information.

Single Date

Update a single date using its API name.

Example:

/API/V2.2/DataTable/Documents.Image.Default:Update?CoreField.Identifier=ZZ1428I&campaigns.Air-date:=2025-09-20

Interval Dates

Update an interval date using a slash ( / ) between the date values.

Example:

/API/V2.2/DataTable/Documents.Image.Default:Update?CoreField.Identifier=ZZ1428I&campaigns.Air-date:=2025-09-20/2025-09-21

From (Start date only)

Update a start date using /NA to indicate an empty end date.

Example:

/API/V2.2/DataTable/Documents.Image.Default:Update?CoreField.Identifier=ZZ1428I&campaigns.Air-date:=2025-09-20/NA

Until (End date only)

Update an end date using /NA to indicate an empty start date.

Example:

/API/V2.2/DataTable/Documents.Image.Default:Update?CoreField.Identifier=ZZ1428I&campaigns.Air-date:=NA/2025-09-20

Indefinite

Update an indefinite date using NA/NA to indicate a date field with no date values.

Example:

/API/V2.2/DataTable/Documents.Image.Default:Update?CoreField.Identifier=ZZ1428I&campaigns.Air-date:=NA/NA

Partial dates (For example, just the month and year)

Update a partial date using /NA to indicate the missing date information.

For example, to update a month and year date without a specific day value, use the following structure:

/API/V2.2/DataTable/Documents.Image.Default:Update?CoreField.Identifier=ZZ1428I&campaigns.Air-date:=2025-09/NA

Checkboxes

Use true and false boolean values to update checkbox fields.

Example:

/API/V2.2/DataTable/Documents.Image.Default:Update?CoreField.Identifier=ZZ1428I&merchandise.Approved:=true