User GuideAPI ReferenceWhat's NewChangelog
API Reference

Update entity

patch
https://data.api.exabel.com/v1/entityTypes//entities/

This can also be used to create an entity by setting allowMissing to true.

Note that this method will update all fields unless updateMask is set.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of an entity type, e.g. entityTypeIdentifier or namespace.entityTypeIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The entity type identifier must match the regex \w[\w-]{0,63}.

string
required

The ID of an entity, e.g. entityIdentifier or namespace.entityIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The entity identifier must match the regex \w[\w-]{0,63}.

Query Params
string

Use this to update only selected fields. For example, specify displayName to update only the display name. If allowMissing is set, this field is ignored.

For REST requests, this is a comma-separated string.

boolean

If set to true, a new entity will be created if it did not exist, and updateMask is ignored.

Body Params

The entity to update.

string

Used when showing the entity in the Exabel app. Required when creating an entity.

string

Used when showing the entity in the Exabel app.

properties
object

Additional properties of this entity. This is currently not used in the Exabel app, but may be in future.

Responses

Updated 5 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago