Create an Obligation

post

https://na1.ironcladapp.com/public/api/v1/obligations

Create a new obligation.

OAuth Scope required: public.obligations.createObligations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The name of the obligation

properties

object

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

obligationTypeKey

array of strings

required

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*

parentId

string

required

The ID of the contract to create the new obligation as a child of. This is useful for creating a new obligation as a child of an existing obligation.

sourceObligationId

string

Associates this obligation with a source obligation. For example, associating a new obligation with a source obligation that has a triggering condition.

description

string

Human-readable description of this obligation.

status

string

The status of the obligation. Only valid when sourceObligationId is present.

dueDate

string

The due date for the obligation (yyyy-MM-dd). Only valid when sourceObligationId is present.

assigneeUserId

string

The user assigned to this obligation. Only valid when sourceObligationId is present.

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

201201

400400

401401

403403