Update an Obligation

patch

https://na1.ironcladapp.com/public/api/v1/obligations/{id}

Update an existing obligation. The path id identifies the obligation to update.

name, obligationTypeKey, addProperties, and removeProperties can be updated on any obligation. status, dueDate, assigneeUserId, and description can be changed only on instances (occurrences of a source obligation) and are rejected on source obligations; to edit an instance, include its sourceObligationId in the body so the path id is treated as an instance. dueDate cannot be changed on recurring instances. At least one updatable field must be supplied.

OAuth Scope required: public.obligations.updateObligations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID or Ironclad ID of the Obligation to update.

Body Params

sourceObligationId

string

Set to the instance's source obligation ID to indicate that the path id refers to a triggered instance, so its instance fields (status, dueDate, assigneeUserId, description) can be updated. Omit it to update a source obligation. Requires triggered obligations to be enabled for your account.

name

string

length ≥ 1

The name of the obligation

addProperties

object

A key:value map of values to set for the obligation's existing properties. This assigns values to properties already defined on the obligation's type; it cannot create new obligation properties (a schema-level change made in Ironclad, not through this API). More details on the properties can be found in the Obligation Properties article.

removeProperties

array of strings

length ≥ 1

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

removeProperties

obligationTypeKey

array of strings

length between 1 and 1

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.

obligationTypeKey

status

string

The status of the obligation instance. Mutable only on instances (obligations that have a source obligation) and rejected on source obligations; include sourceObligationId to target an instance. Valid values are the obligation's instance statuses; the set available depends on the obligation's type and cadence.

dueDate

string

The due date (yyyy-MM-dd). Mutable only on instances and rejected on source obligations; include sourceObligationId to target an instance. Not editable on recurring instances.

assigneeUserId

string

The ID of the user assigned to the obligation. Mutable only on instances and rejected on source obligations; include sourceObligationId to target an instance.

description

string

Human-readable description of the obligation. Mutable only on instances and rejected on source obligations; include sourceObligationId to target an instance.

Headers

x-as-user-email

string

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-id

string

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.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401

403403

404404