API Reference

Create Multiple Contracts

post
https://{account}.sysaidit.com/connect/v1/license-manager/contracts/bulk

Create multiple contracts in a single request, supporting up to 1,000 contracts at a time. The response returns the new contract IDs in the same order you sent them. To ensure consistency, contracts are created as a single unit. If one fails, the entire request is rolled back.

Body Params

Request body for creating multiple contracts in a single call. The dateFormat field specifies the format for all date values. Maximum 1,000 contracts per request. Request body limit is approximately 1 MiB — use compact JSON (no pretty-printing). Unknown top-level fields are rejected with a 400 error.

string
enum
required

The date format used for all date values (startDate, endDate) in this request. All contracts in a single request must use the same format.

Allowed:
contracts
array of objects
required
length between 1 and 1000

Contract items to create. Each item is a contract object.

contracts*

A single contract to create as part of a bulk request. Unknown fields are rejected with a 400 error. applicationId and customFields are not supported in bulk mode — use application (name-based resolution) and the single-create endpoint for customFields.

string
required
length between 1 and 255

The display name of the contract (1–255 characters).

string | null

The display name of the application to link to this contract (1–255 characters if provided). The system resolves the name to an existing application (case-insensitive match). If no match is found, a new application is automatically created and linked.

string
required

The current status of the contract. Allowed values are "active" (currently in effect), "closed" (expired or terminated), and "pipeline" (planned but not yet active).

string | null

The type of software deployment for this contract. Allowed values are "saas" (cloud-based software), "on-prem" (on-premises software), "hybrid" (combination of cloud and on-premises), and "other".

string | null

The application's business category. Allowed values: operations, sales-and-marketing, developer-tools, design, project-management, customer-success, human-resources, it-and-security, finance, productivity, analytics-and-bi, other.

string | null

The start date of the contract, in the format specified by the top-level dateFormat field.

string | null

The end date of the contract, in the format specified by the top-level dateFormat field.

string | null

The billing frequency for this contract. Allowed values are "annual", "monthly", "multiyear", "quarterly", "one-time", and "free".

number | null
≥ 0

The total monetary value of the contract in the specified currency.

string

ISO 4217 currency code for the contract value.

integer | null
≥ 0

The number of licenses included in this contract.

boolean
Defaults to false

Indicates whether the contract renews automatically when it reaches its end date. The default is "false" - doesn't renew automatically.

integer | null
≥ 0

The number of days before the end date for the cancellation notice. The cancellationDeadline is calculated as endDate minus this value.

string | null

The contract owner as free-text (e.g., name or email). Up to 36 characters.

string | null

Free-text notes or comments about the contract.

Responses

Updated 6 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago