Record a custody step

Appends a moved, handed_off, shipped, received or returned step to the asset’s open episode. Invalid transitions answer 409.

RBAC · asset

Path parameters

idstring <uuid>Required

Asset UUID from assets.asset_id.

Request body

Content type: application/json · schema AssetCustodyEventRequest

event_typestringRequired

Enum: movedhanded_offshippedreceivedreturned

Response body

Success response 201 · schema AssetCustodyEnvelope

dataobjectRequired

Response codes

201

Step recorded.

400

Validation failed.

401

x-api-key is missing at middleware.

403

Caller lacks asset update permission.

404

Asset not found or not readable.

409

The asset is not in custody, or the step is not allowed from the current state.

500

Unexpected error.

POST /api/v1/assets/{id}/custody/events

cURL

curl -X POST "https://algapsa.com/api/v1/assets/{id}/custody/events" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "event_type": "moved"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/assets/{id}/custody/events", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "event_type": "moved"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/assets/{id}/custody/events");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""event_type"": ""moved""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

{
  "data": {}
}