Create entity record

Production

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

POST

/v2/api/entity/{entityKey}

Create a record for any entity, addressed by its entityKey (e.g. client, cost_center, work_order).

This is a generic, metadata-driven endpoint. The request body is a JSON object of the new record's field values; 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 and their requirements.

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

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

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Record created.

Bodyapplication/json

🟠422Unprocessable Entity

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

View entity record

Update entity record