Update an Obligation

patch

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

Update an existing obligation.

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

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

name

string

length ≥ 1

The name of the obligation

addProperties

object

A key:value map of properties to add. 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. Mutable only on obligations associated with a source obligation; rejected on source obligations.

dueDate

string

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

assigneeUserId

string

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

description

string

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

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