This feature is only available in the Enterprise version

Metadata templates

Create metadata template

Save a reusable set of metadata keys for your organization.

POST/data/metadata-templates

A metadata template is a named list of metadata keys. People in your organization import it on any Cloud form with a metadata section, so the same keys are spelled the same way on every record. See Metadata templates for how teams use them.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Body

namestringrequiredbody

Template name, such as Loan metadata. Must be unique within your organization.

descriptionstringbody

Note on when to use the template.

keysstring[]requiredbody

Metadata keys the template adds. Keys are trimmed, empty keys are dropped, and duplicates are removed without regard to case (Region and region count as one key). At least one key must remain.

Response

metadata_template_idstring

Unique id of the template (metadata_template_...). Use it to get, update, or delete the template.

namestring

Template name. Unique within your organization.

descriptionstring

Note on when to use the template. Empty string when none was set.

keysstring[]

Metadata keys the template adds to a form, in the order you sent them.

org_idstring

Organization the template belongs to. Templates are shared across every instance in the organization.

created_attimestamp

When the template was created.

updated_attimestamp

When the name, description, or keys last changed.