v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Obligations

Update an Obligation

Update an existing obligation.

OAuth Scope required: public.obligations.updateObligations

patch/obligations/{id}

Path parameters

idstring required

The ID or Ironclad ID of the Obligation to update.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Request body

sourceObligationIdstring

If supplied, edits the obligation (identified by the path id) associated with this source obligation rather than a source obligation itself.

namestring

The name of the obligation

addPropertiesobject

A key:value map of properties to add. More details on the properties can be found in the Obligation Properties article.

removePropertiesstring[]

A list of property keys to remove from the obligation. More details on the properties can be found in the Obligation Properties article.

obligationTypeKeystring[]

The key of the obligation type to be added to the obligation. Only one obligation type can be added or updated per obligation, currently. More info on obligation types can be found in the Obligation Types article.

statusstring

The status of the obligation. Mutable only on obligations associated with a source obligation; rejected on source obligations.

dueDatestring

The due date (yyyy-MM-dd). Mutable only on obligations associated with a source obligation; rejected on source obligations.

assigneeUserIdstring

The user assigned to this obligation. Mutable only on obligations associated with a source obligation; rejected on source obligations.

descriptionstring

Human-readable description of this obligation. Mutable only on obligations associated with a source obligation; rejected on source obligations.

Example request

{
  "removeProperties": [
    "userFacingObligations_description"
  ]
}

Response

200

idstring required

The unique identifier of the obligation

ironcladIdstring required

Readable Ironclad ID of the obligation

namestring required

The name of the obligation

propertiesRecordProperties required

The record properties associated with the record

lastUpdatedstring

The last updated date of the obligation

namedTypeIdsstring[]

The unique identifiers of the types associated with the obligation. These IDs are tied with the Named Type of obligations, like 'Breach Notice', 'Compliance' and so on.

parentReadableIdstring

The parent readable id of the obligation

parentRecordNamestring

The parent record name of the obligation

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "ironcladId": "OB-1",
  "name": "Obligation XYZ",
  "lastUpdated": "2021-01-01T00:00:00Z",
  "namedTypeIds": [
    "eda20988-6b99-404b-99dc-866b84b63883"
  ],
  "parentReadableId": "IC-1",
  "parentRecordName": "Parent Record"
}