Metadata templates
Update metadata template
Rename a metadata template or change its description or keys.
/data/metadata-templates/{metadata_template_id}Send only the fields you want to change. Fields you leave out keep their current value.
Sending keys replaces the whole list, so include every key you want to keep. Records that already used the template keep their metadata. The change only affects forms that import the template from now on.
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-keystring
Enterprise API key, or an OAuth access token.
Path
metadata_template_idstring
Unique id of the template (metadata_template_...). Get it from List metadata templates or Create metadata template.
Body
namestring
New template name. Cannot be empty, and must be unique within your organization.
descriptionstring
New note on when to use the template. Send "" to clear it.
keysstring[]
Full list of keys to replace the current ones. 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
Returns the updated template.
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.