Update entity record

Production

https://{{subdomain}}.daftra.com/v2/api/entity

PUT

/v2/api/entity/{entityKey}/{id}

Update a record of any entity, addressed by its entityKey and primary key id.

This is a generic, metadata-driven endpoint. The request body is a JSON object of the field values to update; which keys are accepted and which are required is defined by the entity's field metadata, so it differs per entityKey. Use the entity schema/fields endpoints to discover an entity's fields.

On success the response carries a confirmation message and the record's id.

Authentication & authorization. Requires an OAuth2 Bearer token and the entity's update permission; otherwise the request is rejected with 401.

Note: the same operation also accepts POST /v2/api/entity/{entityKey}/{id} for web-client backward compatibility.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Record updated.

Bodyapplication/json

🟠400Bad Request

🟠404Not Found

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request PUT 'https://.daftra.com/v2/api/entity/v2/api/entity/cost_center/47' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data '{}'

Response Example

200 - Example 1

{
    "message": "Cost Center Updated Successfully",
    "id": 47
}

Create entity record

Delete entity record