Skip to content

Create a SOP acknowledgment

Knowledge module

POST/sop-acknowledgmentssopAcknowledgments.create

A person's acknowledgment of an SOP version. Creates a SOP acknowledgment. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability knowledge.sop.acknowledge.
  • OAuth scopes: knowledge.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: SopAcknowledgmentCreate

sopAcknowledgments.create: SopAcknowledgmentCreate
FieldTypeRequiredDescription
sop_idstring (uuid)YesIdentifier of the SOP.
{
  "sop_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: SopAcknowledgment

sopAcknowledgments.create: SopAcknowledgment
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the sop acknowledgment.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
sop_idstring (uuid)YesIdentifier of the SOP.
person_idstring (uuid)YesIdentifier of the acknowledging person.
acknowledged_atstring (date-time)YesWhen it was acknowledged.
sop_versionintegerYesVersion acknowledged.Constraints: range 1 to any
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "sop_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "acknowledged_at": "2026-10-08T14:30:00Z",
  "sop_version": 2
}

Code samples

curl -X POST "$XOS_BASE_URL/sop-acknowledgments" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"sop_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.sopAcknowledgments.create({
    "sop_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.sop_acknowledgments.create({"sop_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos sop-acknowledgments create --data '{"sop_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'