Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

contracts

Creates a contract

You need to be a user with TenantAdmin role to access this resource

post/contracts

Request body

Example request

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/contracts/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "name": "Contract name",
      "available_roles": [
        {
          "role": "admin"
        }
      ],
      "status": "active",
      "support_user_id": "5b4f337bff4304610483ba67",
      "feature_flags": {
        "disable_recipe_feature": true,
        "subscribe_to_error_by_default": true
      }
    },
    "relationships": {
      "members": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ],
        "links": {
          "self": "/v2/contracts/5b4f337bff4304610483ba67/members"
        }
      },
      "workspaces": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ]
      },
      "invites": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ],
        "links": {
          "self": "/v2/contracts/5b4f337bff4304610483ba67/invites"
        }
      }
    }
  }
}

Response

Created

metaobject required

Example response

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/contracts/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "name": "Contract name",
      "available_roles": [
        {
          "role": "admin"
        }
      ],
      "status": "active",
      "support_user_id": "5b4f337bff4304610483ba67",
      "feature_flags": {
        "disable_recipe_feature": true,
        "subscribe_to_error_by_default": true
      }
    },
    "relationships": {
      "members": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ],
        "links": {
          "self": "/v2/contracts/5b4f337bff4304610483ba67/members"
        }
      },
      "workspaces": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ]
      },
      "invites": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ],
        "links": {
          "self": "/v2/contracts/5b4f337bff4304610483ba67/invites"
        }
      }
    }
  }
}