Command ping

POST /commands/ping/{entityId}

Reference command — exercises the command contract end to end

Authorization

bearer

AuthorizationBearer <token>

In: header

entityId*string

idempotency-key*string

One key per logical user action, reused across transport retries of that action. Never per-session and never per-request.

Length1 <= length

application/json

TypeScript Definitions

Use the request body type in TypeScript.

note?string

curl -X POST "https://api.part3.io/v1/commands/ping/string" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "eventId": "string",
  "status": "applied",
  "note": "string"
}

{
  "error": "string",
  "errorCode": "string",
  "requestId": "string"
}

{
  "error": "string",
  "errorCode": "string",
  "requestId": "string"
}