Customer Applicability API

Update tenant-owned lifecycle state for a customer obligation instance

patch/api/v1/customer-obligation-instances/{customer_obligation_instance_id}

Request

  • Base URL: https://api.esheria.ai
  • URL: https://api.esheria.ai/api/v1/customer-obligation-instances/{customer_obligation_instance_id}
  • Auth: API key in header x-api-key

Path parameters

customer_obligation_instance_idstring uuid required

Headers

idempotency-keystring required

Unique key for mutating request replay protection.

Request body

status'candidate' | 'accepted' | 'not_applicable' | 'monitoring' | 'retired' nullable
owner_user_idstring nullable
owner_labelstring nullable
due_datestring nullable
priority'low' | 'normal' | 'high' | 'urgent' nullable
status_reasonstring nullable
status_updated_bystring nullable
lifecycle_metadataobject

Example request

{
  "due_date": "2026-07-31",
  "lifecycle_metadata": {
    "ticket_id": "COMP-42"
  },
  "owner_label": "Compliance lead",
  "owner_user_id": "usr_123",
  "priority": "high",
  "status": "monitoring",
  "status_reason": "Accepted into the compliance work queue."
}

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.