Skip to main content
PUT
/
v2
/
entities
/
{id}
Update Entity
curl --request PUT \
  --url https://public.api.serval.com/v2/entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldValues": [
    {
      "fieldId": "<string>",
      "fieldKey": "<string>",
      "value": 123,
      "pinned": true
    }
  ],
  "name": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "number": 123,
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "entityTypeKey": "<string>",
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "fieldValues": [
      {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "pinned": true
      }
    ],
    "sourceAppInstanceIds": [
      "<string>"
    ],
    "sharedMetadata": {
      "sourceTeamId": "<string>",
      "sourceTeamName": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.serval.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the entity.

Body

application/json
​
fieldValues
EntityFieldValueInput · object[]

The field values to set. Only provided fields are updated; omitted fields are untouched.

​
name
string

Convenience field to update the entity's name. Sets the value of the entity type's name field (is_name_field). Ignored if field_values already contains a value for the name field.

Response

Success

​
data
data · object

The updated entity.