> ## Documentation Index > Fetch the complete documentation index at: https://www.1password.dev/llms.txt > Use this file to discover all available pages before exploring further. # Create or update a contract > Creates a contract, or updates an existing one matched by its `id` or your own `externalId`. Either all line items carry an `externalId` or none do. Set the business owner with `businessOwnerEmail`. **Required scope:** `Contracts.Write` (Write access to contracts) ## OpenAPI ````yaml /openapi/saas_manager_api.json put /api/contracts/v1 openapi: 3.0.4 info: title: SaaS Manager API description: >- By accessing or using 1Password Developer Tools, you agree to the [API and SDK Terms of Service](https://1password.com/legal/api-sdk-terms-of-service). --- The SaaS Manager public REST API lets you read and manage your applications, people, teams, contracts, devices, workflows and audit log programmatically. Resources are grouped by area (see the navigation). The conventions below apply across the whole API. ## Regions and base URL SaaS Manager is hosted in multiple regions. Pick the base URL for your tenant's region from the **Servers** dropdown — `https://app.trelica.com` (United States) or `https://eu.trelica.com` (Europe). Endpoint URLs throughout this reference use whichever server you select. ## Authentication Every request must send an `Authorization` header carrying an OAuth 2.0 access token, prefixed with `Bearer`: ``` Authorization: Bearer ``` Obtain a token using either the **Client Credentials** flow (machine-to-machine) or the **Authorization Code** flow (acting on behalf of a user). The scopes granted to your token determine which endpoints you may call — see [Scopes](#scopes). Access tokens expire. When a token is missing, invalid or expired you receive `401 Unauthorized`; inspect the `WWW-Authenticate` response header for detail, for example: ``` Bearer error="invalid_token", error_description="The token expired at '12/23/2020 10:27:15'" ``` If you used the Authorization Code flow with the `offline_access` scope, use your refresh token to obtain a new access token. A `403 Forbidden` means the token is valid but lacks the scope required by the endpoint. ## Dates and times Dates and date/times are sent and returned in [RFC 3339](https://tools.ietf.org/html/rfc3339) format (essentially ISO 8601), for example `2020-12-25` (midnight) or `2020-12-25T10:50:00Z`. Field names ending in `Dtm` carry a meaningful time component; field names ending in `Date` are date-only. ## Optional fields and null Responses omit fields that have no value — you will see the field absent rather than returned as `null`. When creating or replacing a resource (`PUT`), any field you omit is cleared. With `PATCH`, omitting a field leaves it unchanged, whereas sending it as `null` clears it. ## Pagination List endpoints are paginated and return at most 100 results by default. Request a different upper bound with the `limit` query parameter (maximum 1000) — you may receive fewer than requested. Request the next page with the `after` query parameter, passing the opaque cursor token that SaaS Manager supplies. The response's `next` field (and the `link` response header, `rel="next"`) contains the full URL for the next page: ```json { "next": "https://app.trelica.com/api/people/v1?after=&limit=100", "results": [ { /* ... */ } ] } ``` Keep requesting pages until no further results are returned. (User data exposed over SCIM uses the SCIM `startIndex`/`count` pagination scheme instead.) ## Filtering Many list endpoints accept a `filter` query parameter (URL-encoded) based on the [SCIM filtering specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2). A filter is one or more expressions — an attribute name, an operator, and an optional value — combined with `and`, `or`, `not`, and grouped with parentheses. Attribute names match the JSON returned and may use dot notation for nested attributes (e.g. `createdBy.email`). For an attribute that is an **array of objects**, put a sub-expression in brackets — the item matches when *any* element satisfies it: `teams[name eq "Developers"]` or `teams[id eq "5f8d0a1b2c3d4e5f60718293"]`. Values are strings (double-quoted), integers, dates (double-quoted, RFC 3339) or booleans. Some list endpoints also accept a free-text `q` parameter that searches the resource's displayable fields. Soft-deleted entities are excluded by default; include them with a filter that references `deleted` (e.g. `filter=deleted eq true`). | Operator | Meaning | Behaviour | |----------|---------|-----------| | `eq` | equal | Attribute value is identical to the operator value | | `ne` | not equal | Attribute value differs from the operator value | | `co` | contains | Attribute value contains the operator value text | | `sw` | starts with | Attribute value starts with the operator value text | | `ew` | ends with | Attribute value ends with the operator value text | | `pr` | present | Attribute has a non-empty / non-null value | | `gt` | greater than | Attribute value is greater than the operator value | | `ge` | greater than or equal | Attribute value is greater than or equal to the operator value | | `lt` | less than | Attribute value is less than the operator value | | `le` | less than or equal | Attribute value is less than or equal to the operator value | For `gt`/`ge`/`lt`/`le`, strings compare lexicographically, dates chronologically and numbers numerically. Each list endpoint documents the fields you can filter on. **Examples** | Filter | Result | |--------|--------| | `firstName sw "Jan"` | People whose first name starts with "Jan" | | `teams[name eq "Developers"]` | People in the team called Developers | | `not (leavingDate pr)` | People with no leaving date | | `lastModifiedDtm ge "2021-06-01"` | Records modified on or after 1 June 2021 | ## Errors A `400 Bad Request` indicates a problem with your request. The body is a problem-details object: `errors` maps each offending field to its messages, with `title`, `status`, a `type` URL, and an `extensions.traceId` for correlation: ```json { "errors": { "leavingDate": [ "Error converting value \"2020-40-40\" ..." ] }, "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "extensions": { "traceId": "00-91e4405b...-00" } } ``` You should not normally see `500 Internal Server Error`. If you do, the body is a generic message — please contact [saasmanager@1password.com](mailto:saasmanager@1password.com) with details of the request so we can investigate. ## Scopes Scopes define what an API app may do. Following security best practice, grant only the scopes you need. Each endpoint documents the scope(s) it requires. | Scope | Description | |-------|-------------| | `Apps.Read` | Read-only access to applications | | `Apps.Users.Read` | Read-only access to application accounts | | `Apps.Write` | Write access to applications | | `Assets.Read` | Read-only access to devices | | `Assets.Write` | Write access to devices | | `AuditLog.Read` | Read-only access to the audit log | | `Contracts.Read` | Read-only access to contracts | | `Contracts.Write` | Write access to contracts | | `People.Read` | Read-only access to people and teams | | `People.Write` | Write access to people and teams | | `Users.Read` | Read-only access to users with access to SaaS Manager | | `Users.Write` | Write access to users with access to SaaS Manager | | `Workflows.Read` | Read-only access to workflow definitions | | `Workflows.Runs.Read` | Read-only access to workflow runs | | `Workflows.Runs.Execute` | Execute workflow run actions | | `Workflows.Runs.ReadSecrets` | Read workflow run secrets | | `offline_access` | Issue a refresh token alongside the access token (Authorization Code flow) | contact: name: 1Password SaaS Manager Support email: saasmanager@1password.com version: v1 servers: - url: https://app.trelica.com description: United States - url: https://eu.trelica.com description: Europe security: [] tags: - name: Authentication description: >- Obtain an OAuth 2.0 access token. Use the Client Credentials flow for machine-to-machine access, or the Authorization Code flow to act on behalf of a user. - name: Applications description: >- List, search and manage applications, and list the accounts (users) on an application. - name: People description: List, search and manage the people in your organization. - name: Teams description: List and manage teams and the team hierarchy. - name: Contracts description: List and manage contracts. - name: Devices description: List and manage devices. The endpoints live under `/api/assets`. - name: Workflows description: >- List workflows (with their triggers and steps), list their runs, and fire signals on steps that are waiting for input. - name: Audit log description: >- Read your organization's audit log: a continuous, filterable stream of events. - name: SCIM description: >- Provision and manage users via the SCIM 2.0 protocol (RFC 7644). These endpoints follow the SCIM standard rather than the conventions used by the rest of the SaaS Manager API: they use `startIndex`/`count` paging, return a SCIM `ListResponse` envelope, identify schemas with `urn:` URIs, and exchange `application/scim+json`. The `ResourceTypes` endpoints support SCIM discovery (RFC 7643). paths: /api/contracts/v1: put: tags: - Contracts summary: Create or update a contract description: >- Creates a contract, or updates an existing one matched by its `id` or your own `externalId`. Either all line items carry an `externalId` or none do. Set the business owner with `businessOwnerEmail`. **Required scope:** `Contracts.Write` (Write access to contracts) requestBody: content: application/json: schema: $ref: '#/components/schemas/Contract' example: id: 6609682bdb3cf6ec72b95839 externalId: EXT1235 ref: PO-12345-00 type: PurchaseOrder vendorName: Github, Inc. agreementDate: '2022-04-01T00:00:00Z' renewalDate: '2023-04-01T00:00:00Z' terminationNoticeDays: 90 isAutomaticRenewal: false notes: Annual Github renewal negotiated by Rachele in procurement paymentMethod: Invoice businessOwnerEmail: jane.doe@example.org lineItems: - externalId: '1' description: Github Enterprise annual notes: For source control unitCount: 50 amount: 210 currency: USD baseAmount: 210 baseCurrency: USD startDate: '2022-04-06T00:00:00Z' endDate: '2023-04-06T00:00:00Z' - externalId: '2' description: Github Advanced Security notes: Secret scanning etc unitCount: 10 amount: 250 currency: USD baseAmount: 250 baseCurrency: USD startDate: '2022-04-06T00:00:00Z' endDate: '2023-04-06T00:00:00Z' documents: [] createdBy: userId: 110e3dd8077945c2a60d33770eb74b97 name: Sam Procurement email: sam.procurement@example.org createdDtm: '2024-03-31T13:42:03.608Z' lastModifiedBy: userId: 110e3dd8077945c2a60d33770eb74b97 name: Sam Procurement email: sam.procurement@example.org lastModifiedDtm: '2024-03-31T13:42:03.608Z' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Contract' example: id: 6609682bdb3cf6ec72b95839 externalId: EXT1235 ref: PO-12345-00 type: PurchaseOrder vendorName: Github, Inc. agreementDate: '2022-04-01T00:00:00Z' renewalDate: '2023-04-01T00:00:00Z' terminationNoticeDays: 90 isAutomaticRenewal: false notes: Annual Github renewal negotiated by Rachele in procurement paymentMethod: Invoice businessOwnerEmail: jane.doe@example.org lineItems: - externalId: '1' description: Github Enterprise annual notes: For source control unitCount: 50 amount: 210 currency: USD baseAmount: 210 baseCurrency: USD startDate: '2022-04-06T00:00:00Z' endDate: '2023-04-06T00:00:00Z' - externalId: '2' description: Github Advanced Security notes: Secret scanning etc unitCount: 10 amount: 250 currency: USD baseAmount: 250 baseCurrency: USD startDate: '2022-04-06T00:00:00Z' endDate: '2023-04-06T00:00:00Z' documents: [] createdBy: userId: 110e3dd8077945c2a60d33770eb74b97 name: Sam Procurement email: sam.procurement@example.org createdDtm: '2024-03-31T13:42:03.608Z' lastModifiedBy: userId: 110e3dd8077945c2a60d33770eb74b97 name: Sam Procurement email: sam.procurement@example.org lastModifiedDtm: '2024-03-31T13:42:03.608Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: One or more validation errors occurred. status: 400 detail: >- The request body failed validation. See errors for the offending fields. errors: email: - The email field is required. traceId: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01 '401': description: Unauthorized '403': description: Forbidden security: - oauth2: - Contracts.Write components: schemas: Contract: type: object properties: id: type: string description: >- The contract's SaaS Manager ID. Supply to update an existing contract. nullable: true externalId: type: string description: >- Your own external ID for the contract. Supply to match an existing contract on update. nullable: true ref: type: string description: A reference for the contract, e.g. a PO number nullable: true type: allOf: - $ref: '#/components/schemas/ContractType' description: The contract type vendorName: type: string description: The vendor name nullable: true startDate: type: string description: (ISO format) The contract's start date format: date-time nullable: true agreementDate: type: string description: (ISO format) The agreement date. Defaults to now on creation. format: date-time nullable: true renewalDate: type: string description: (ISO format) The renewal date format: date-time nullable: true isRolling: type: boolean description: Whether the contract is a rolling contract nullable: true terminationNoticeDays: type: integer description: The number of days' notice required to terminate the contract format: int32 nullable: true isAutomaticRenewal: type: boolean description: Whether the contract renews automatically nullable: true notes: type: string description: Notes about the contract nullable: true paymentMethod: allOf: - $ref: '#/components/schemas/AppLicensePaymentMethod' description: The payment method nullable: true businessOwnerEmail: type: string description: The email address of the contract's business owner nullable: true lineItems: type: array items: $ref: '#/components/schemas/ContractLineItem' description: The contract's line items nullable: true documents: type: array items: $ref: '#/components/schemas/ContractDocument' description: Documents linked to the contract nullable: true createdBy: allOf: - $ref: '#/components/schemas/UserInfo' description: The user that created the contract record nullable: true readOnly: true createdDtm: type: string description: The timestamp for when the contract record was created format: date-time nullable: true readOnly: true lastModifiedBy: allOf: - $ref: '#/components/schemas/UserInfo' description: The user that last modified the contract record nullable: true readOnly: true lastModifiedDtm: type: string description: The timestamp for when the contract record was last modified format: date-time nullable: true readOnly: true additionalProperties: false description: A contract Error: type: object properties: type: type: string description: A URI reference identifying the problem type. title: type: string description: A short, human-readable summary of the problem. status: type: integer description: The HTTP status code. format: int32 detail: type: string description: >- A human-readable explanation specific to this occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: Validation errors keyed by field name. Present on 400 responses. traceId: type: string description: >- A trace identifier for correlating the error with SaaS Manager support. additionalProperties: false description: An error response (RFC 7807 problem details). ContractType: enum: - OrderForm - MSA - GenericContract - PurchaseOrder - Subscription type: string AppLicensePaymentMethod: enum: - CreditCard - Invoice type: string ContractLineItem: type: object properties: externalId: type: string description: >- Your own external ID for the line item. Either all line items have one, or none do. nullable: true description: type: string description: A description of the line item nullable: true notes: type: string description: Notes about the line item nullable: true unitCount: type: integer description: The number of units format: int32 nullable: true amount: type: number description: The amount, in the currency given by currency format: double nullable: true currency: type: string description: The ISO currency code for amount. Defaults to your base currency. nullable: true baseAmount: type: number description: The amount converted to your base currency format: double nullable: true readOnly: true baseCurrency: type: string description: Your base ISO currency code nullable: true readOnly: true startDate: type: string description: (ISO format) The line item's start date format: date-time nullable: true endDate: type: string description: (ISO format) The line item's end date format: date-time nullable: true additionalProperties: false description: A line item on a contract ContractDocument: type: object properties: linkUrl: type: string description: A URL linking to the document nullable: true description: type: string description: A description of the document nullable: true additionalProperties: false description: A document linked to a contract UserInfo: type: object properties: userId: type: string nullable: true name: type: string nullable: true email: type: string nullable: true additionalProperties: false securitySchemes: oauth2: type: oauth2 description: >- OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as `Authorization: Bearer `. flows: clientCredentials: tokenUrl: https://app.trelica.com/connect/token scopes: Apps.Read: Read-only access to applications Apps.Users.Read: Read-only access to application accounts Apps.Write: Write access to applications Assets.Read: Read-only access to devices Assets.Write: Write access to devices AuditLog.Read: Read-only access to the audit log Contracts.Read: Read-only access to contracts Contracts.Write: Write access to contracts People.Read: Read-only access to people and teams People.Write: Write access to people and teams Users.Read: Read-only access to users with access to SaaS Manager Users.Write: Write access to users with access to SaaS Manager Workflows.Read: Read-only access to workflow definitions Workflows.Runs.Read: Read-only access to workflow runs Workflows.Runs.Execute: Execute workflow run actions Workflows.Runs.ReadSecrets: Read workflow run secrets offline_access: >- Issue a refresh token alongside the access token (Authorization Code flow) authorizationCode: authorizationUrl: https://app.trelica.com/connect/authorize tokenUrl: https://app.trelica.com/connect/token scopes: Apps.Read: Read-only access to applications Apps.Users.Read: Read-only access to application accounts Apps.Write: Write access to applications Assets.Read: Read-only access to devices Assets.Write: Write access to devices AuditLog.Read: Read-only access to the audit log Contracts.Read: Read-only access to contracts Contracts.Write: Write access to contracts People.Read: Read-only access to people and teams People.Write: Write access to people and teams Users.Read: Read-only access to users with access to SaaS Manager Users.Write: Write access to users with access to SaaS Manager Workflows.Read: Read-only access to workflow definitions Workflows.Runs.Read: Read-only access to workflow runs Workflows.Runs.Execute: Execute workflow run actions Workflows.Runs.ReadSecrets: Read workflow run secrets offline_access: >- Issue a refresh token alongside the access token (Authorization Code flow) ```` ## Related topics - [Create or update a team](/api-reference/teams/create-or-update-a-team.md) - [Get a contract](/api-reference/contracts/get-a-contract.md) - [List contracts](/api-reference/contracts/list-contracts.md)