--- title: "Run an Action on a Record" method: POST path: "/records/{id}/actions" tags: ["Records"] --- # Run an Action on a Record `POST /records/{id}/actions` Runs an action on the contract. It supports lifecycle actions such as activating a contract. **OAuth Scope required:** `public.records.applyContractAction` ## Path parameters - `id` string, required ## Request body - union - object - `type` 'activate', required — The action type to run on the contract. - `properties` object, required - `standard_terminationNoticePeriod` object — This is the number of days of notice that needs to be given before this agreement can be terminated. - `type` 'duration', required - `value` string, required - `effectiveDate` object — Effective date is when this agreement begins and is considered active. If effective date is not defined then the executed date of the agreement is used to mark the contract as active. - `type` 'date', required - `value` string, required - `standard_renewalsRemaining` object — The number of renewals an auto-renewal or optional extension with limited renewals has left. - `type` 'number', required - `value` number, required - `standard_renewalOptOutDate` object — An agreement may have an opt-out date that lets you opt-out of the upcoming auto-renewal before it renews. - `type` 'date', required - `value` string, required - `standard_renewalOptOutPeriod` object — An agreement may have an opt-out period that lets you opt-out of the upcoming auto-renewal before it renews. In the case of an opt period the last day to opt-out is the expiration date minus the opt-out period. - `type` 'duration', required - `value` string, required - `standard_renewalTermLength` object — Renewal Term Length - `type` 'duration', required - `value` string, required - `standard_renewalType` object, required — The renewal type for an agreement will govern what happens on its expiration date if it has one. Accepted values for renewal type: Auto-Renew: These agreements will automatically renew on their expiration date which means they will then have a new expiration date which would be the current date plus the renewal term length. Optional Extension: These agreements have an optional extension which means that the party can choose to renew the agreement by the renewal term length without renegotiating the contract. There may be a notification requirement to exercise this option. Evergreen: These are agreements that don't have an expiration date, which means they are active forever. Also known as perpetual agreements. None: These agreements that don't have a renewal provision and will expire on their expiration date. If an agreement has no renewal provision but also doesn't have an expiration date, it'll be active forever. Other: For renewal provisions that are not covered by these options. - `type` 'string', required - `value` 'Auto-Renew' | 'Optional Extension' | 'Evergreen' | 'None' | 'Other', required - `otherRenewalType` object — This property helps downstream reporting for when you have a renewal type not defined by the system. - `type` 'string', required - `value` string, required - `standard_initialTermLength` object — The initial term is the time from the effective date that the agreement will be effective for. If not defined, then the agreement will be active until the expiration date. If an expiration date is also not defined then the agreement will be active indefinitely, until the status of the agreement is manually changed. - `type` 'duration', required - `value` string, required - `expirationDate` object — Expiration date is when this agreement will end or become inactive. If an expiration date isn't present then the effective date plus the initial term length are used to expire the contract. - `type` 'date', required - `value` string, required - object - `type` 'terminate', required — The action type to run on the contract. - `properties` object, required - `standard_terminatedDate` object, required — The date when the contract was terminated. - `type` 'date', required - `value` string, required - `standard_terminationEffectiveDate` object, required — The effective date of the contract termination. - `type` 'date', required - `value` string, required - `standard_terminatingRecordId` object — The record ID for the contract that terminated this contract. - `type` 'string', required - `value` string, required - object - `type` 'supersede', required — The action type to run on the contract. - `properties` object, required - `standard_supersededDate` object, required — Superseded Date - `type` 'date', required - `value` string, required - `standard_supersessionEffectiveDate` object, required — Supersession Effective Date - `type` 'date', required - `value` string, required - `standard_supersedingRecordId` object — The record ID for the contract that has superseded this contract. - `type` 'string', required - `value` string, required - object - `type` 'extend', required — The action type to run on the contract. - `properties` RenewalTermLengthContractActionProperties, required - `standard_renewalTermLength` object — Renewal Term Length - `type` 'duration', required - `value` string, required - object - `type` 'cancelAutoRenewal', required — The action type to run on the contract. - object - `type` 'editRenewal', required — The action type to run on the contract. - `properties` object, required - `standard_renewalsRemaining` object — The number of renewals an auto-renewal or optional extension with limited renewals has left. - `type` 'number', required - `value` number, required - `standard_renewalOptOutDate` object — An agreement may have an opt-out date that lets you opt-out of the upcoming auto-renewal before it renews. - `type` 'date', required - `value` string, required - `standard_renewalOptOutPeriod` object — An agreement may have an opt-out period that lets you opt-out of the upcoming auto-renewal before it renews. In the case of an opt period the last day to opt-out is the expiration date minus the opt-out period. - `type` 'duration', required - `value` string, required - `standard_renewalTermLength` object — Renewal Term Length - `type` 'duration', required - `value` string, required - `standard_renewalType` object, required — The renewal type for an agreement will govern what happens on its expiration date if it has one. Accepted values for renewal type: Auto-Renew: These agreements will automatically renew on their expiration date which means they will then have a new expiration date which would be the current date plus the renewal term length. Optional Extension: These agreements have an optional extension which means that the party can choose to renew the agreement by the renewal term length without renegotiating the contract. There may be a notification requirement to exercise this option. Evergreen: These are agreements that don't have an expiration date, which means they are active forever. Also known as perpetual agreements. None: These agreements that don't have a renewal provision and will expire on their expiration date. If an agreement has no renewal provision but also doesn't have an expiration date, it'll be active forever. Other: For renewal provisions that are not covered by these options. - `type` 'string', required - `value` 'Auto-Renew' | 'Optional Extension' | 'Evergreen' | 'None' | 'Other', required - `otherRenewalType` object — This property helps downstream reporting for when you have a renewal type not defined by the system. - `type` 'string', required - `value` string, required - `standard_initialTermLength` object — The initial term is the time from the effective date that the agreement will be effective for. If not defined, then the agreement will be active until the expiration date. If an expiration date is also not defined then the agreement will be active indefinitely, until the status of the agreement is manually changed. - `type` 'duration', required - `value` string, required - `expirationDate` object — Expiration date is when this agreement will end or become inactive. If an expiration date isn't present then the effective date plus the initial term length are used to expire the contract. - `type` 'date', required - `value` string, required - object - `type` 'undo', required — The action type to run on the contract. - `properties` object, required - `standard_undoObligationAction` object, required — The action type that is being undone by an undo action. - `type` 'string', required - `value` 'activate' | 'terminate' | 'supersede' | 'extend' | 'cancelAutoRenewal' | 'editRenewal' | 'undo', required ## Response `200` 200 - union - object - `type` 'activate', required — The action type to run on the contract. - `properties` object, required - `standard_terminationNoticePeriod` object — This is the number of days of notice that needs to be given before this agreement can be terminated. - `type` 'duration', required - `value` string, required - `effectiveDate` object — Effective date is when this agreement begins and is considered active. If effective date is not defined then the executed date of the agreement is used to mark the contract as active. - `type` 'date', required - `value` string, required - `standard_renewalsRemaining` object — The number of renewals an auto-renewal or optional extension with limited renewals has left. - `type` 'number', required - `value` number, required - `standard_renewalOptOutDate` object — An agreement may have an opt-out date that lets you opt-out of the upcoming auto-renewal before it renews. - `type` 'date', required - `value` string, required - `standard_renewalOptOutPeriod` object — An agreement may have an opt-out period that lets you opt-out of the upcoming auto-renewal before it renews. In the case of an opt period the last day to opt-out is the expiration date minus the opt-out period. - `type` 'duration', required - `value` string, required - `standard_renewalTermLength` object — Renewal Term Length - `type` 'duration', required - `value` string, required - `standard_renewalType` object, required — The renewal type for an agreement will govern what happens on its expiration date if it has one. Accepted values for renewal type: Auto-Renew: These agreements will automatically renew on their expiration date which means they will then have a new expiration date which would be the current date plus the renewal term length. Optional Extension: These agreements have an optional extension which means that the party can choose to renew the agreement by the renewal term length without renegotiating the contract. There may be a notification requirement to exercise this option. Evergreen: These are agreements that don't have an expiration date, which means they are active forever. Also known as perpetual agreements. None: These agreements that don't have a renewal provision and will expire on their expiration date. If an agreement has no renewal provision but also doesn't have an expiration date, it'll be active forever. Other: For renewal provisions that are not covered by these options. - `type` 'string', required - `value` 'Auto-Renew' | 'Optional Extension' | 'Evergreen' | 'None' | 'Other', required - `otherRenewalType` object — This property helps downstream reporting for when you have a renewal type not defined by the system. - `type` 'string', required - `value` string, required - `standard_initialTermLength` object — The initial term is the time from the effective date that the agreement will be effective for. If not defined, then the agreement will be active until the expiration date. If an expiration date is also not defined then the agreement will be active indefinitely, until the status of the agreement is manually changed. - `type` 'duration', required - `value` string, required - `expirationDate` object — Expiration date is when this agreement will end or become inactive. If an expiration date isn't present then the effective date plus the initial term length are used to expire the contract. - `type` 'date', required - `value` string, required - object - `type` 'terminate', required — The action type to run on the contract. - `properties` object, required - `standard_terminatedDate` object, required — The date when the contract was terminated. - `type` 'date', required - `value` string, required - `standard_terminationEffectiveDate` object, required — The effective date of the contract termination. - `type` 'date', required - `value` string, required - `standard_terminatingRecordId` object — The record ID for the contract that terminated this contract. - `type` 'string', required - `value` string, required - object - `type` 'supersede', required — The action type to run on the contract. - `properties` object, required - `standard_supersededDate` object, required — Superseded Date - `type` 'date', required - `value` string, required - `standard_supersessionEffectiveDate` object, required — Supersession Effective Date - `type` 'date', required - `value` string, required - `standard_supersedingRecordId` object — The record ID for the contract that has superseded this contract. - `type` 'string', required - `value` string, required - object - `type` 'extend', required — The action type to run on the contract. - `properties` RenewalTermLengthContractActionProperties, required - `standard_renewalTermLength` object — Renewal Term Length - `type` 'duration', required - `value` string, required - object - `type` 'cancelAutoRenewal', required — The action type to run on the contract. - object - `type` 'editRenewal', required — The action type to run on the contract. - `properties` object, required - `standard_renewalsRemaining` object — The number of renewals an auto-renewal or optional extension with limited renewals has left. - `type` 'number', required - `value` number, required - `standard_renewalOptOutDate` object — An agreement may have an opt-out date that lets you opt-out of the upcoming auto-renewal before it renews. - `type` 'date', required - `value` string, required - `standard_renewalOptOutPeriod` object — An agreement may have an opt-out period that lets you opt-out of the upcoming auto-renewal before it renews. In the case of an opt period the last day to opt-out is the expiration date minus the opt-out period. - `type` 'duration', required - `value` string, required - `standard_renewalTermLength` object — Renewal Term Length - `type` 'duration', required - `value` string, required - `standard_renewalType` object, required — The renewal type for an agreement will govern what happens on its expiration date if it has one. Accepted values for renewal type: Auto-Renew: These agreements will automatically renew on their expiration date which means they will then have a new expiration date which would be the current date plus the renewal term length. Optional Extension: These agreements have an optional extension which means that the party can choose to renew the agreement by the renewal term length without renegotiating the contract. There may be a notification requirement to exercise this option. Evergreen: These are agreements that don't have an expiration date, which means they are active forever. Also known as perpetual agreements. None: These agreements that don't have a renewal provision and will expire on their expiration date. If an agreement has no renewal provision but also doesn't have an expiration date, it'll be active forever. Other: For renewal provisions that are not covered by these options. - `type` 'string', required - `value` 'Auto-Renew' | 'Optional Extension' | 'Evergreen' | 'None' | 'Other', required - `otherRenewalType` object — This property helps downstream reporting for when you have a renewal type not defined by the system. - `type` 'string', required - `value` string, required - `standard_initialTermLength` object — The initial term is the time from the effective date that the agreement will be effective for. If not defined, then the agreement will be active until the expiration date. If an expiration date is also not defined then the agreement will be active indefinitely, until the status of the agreement is manually changed. - `type` 'duration', required - `value` string, required - `expirationDate` object — Expiration date is when this agreement will end or become inactive. If an expiration date isn't present then the effective date plus the initial term length are used to expire the contract. - `type` 'date', required - `value` string, required - object - `type` 'undo', required — The action type to run on the contract. - `properties` object, required - `standard_undoObligationAction` object, required — The action type that is being undone by an undo action. - `type` 'string', required - `value` 'activate' | 'terminate' | 'supersede' | 'extend' | 'cancelAutoRenewal' | 'editRenewal' | 'undo', required ## Other responses - `400` — Bad input for contract action - `403` — 403 - `404` — 404 not found --- [API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)