IRironcladapp
Records

Run an Action on a Record

Runs an action on the contract. It supports lifecycle actions such as activating a contract.

OAuth Scope required: public.records.applyContractAction

post/records/{id}/actions

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/records/{id}/actions
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.records.applyContractAction

Path parameters

idstring required

The ID or Ironclad ID of the Record. For an explanation of Record IDs or Ironclad IDs and how to find them, see Getting Started.

Request body

OR
OR
OR
OR
OR
OR

Example request

{
  "properties": {
    "standard_terminationNoticePeriod": {
      "value": "P14D"
    },
    "effectiveDate": {
      "value": "2018-05-08T00:00:00-07:00"
    },
    "standard_renewalsRemaining": {
      "value": 5
    },
    "standard_renewalOptOutDate": {
      "value": "2018-05-08T00:00:00-07:00"
    },
    "standard_renewalOptOutPeriod": {
      "value": "P1M"
    },
    "standard_renewalTermLength": {
      "value": "P1Y"
    },
    "otherRenewalType": {
      "value": "Custom Auto-Renew"
    },
    "standard_initialTermLength": {
      "value": "P1Y"
    },
    "expirationDate": {
      "value": "2018-05-08T00:00:00-07:00"
    }
  }
}

Response

200

OR
OR
OR
OR
OR
OR

Example response

{
  "properties": {
    "standard_terminationNoticePeriod": {
      "value": "P14D"
    },
    "effectiveDate": {
      "value": "2018-05-08T00:00:00-07:00"
    },
    "standard_renewalsRemaining": {
      "value": 5
    },
    "standard_renewalOptOutDate": {
      "value": "2018-05-08T00:00:00-07:00"
    },
    "standard_renewalOptOutPeriod": {
      "value": "P1M"
    },
    "standard_renewalTermLength": {
      "value": "P1Y"
    },
    "otherRenewalType": {
      "value": "Custom Auto-Renew"
    },
    "standard_initialTermLength": {
      "value": "P1Y"
    },
    "expirationDate": {
      "value": "2018-05-08T00:00:00-07:00"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.