Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

contracts

Invites user to the defined contract and workspace, if last one is specified

You need have contracts.membership.edit permission or to be a user with TenantAdmin role to access this resource. To provide the workspase_id as an additional parameter user has to have permission workspaces.workspace.edit and belong to the provided workspace.

post/contracts/{contract_id}/invites

Path parameters

contract_idstring required

Contract identifier

Request body

Example request

{
  "data": {
    "attributes": {
      "email": "john.doe@gmail.com",
      "roles": [
        "admin"
      ],
      "workspace_id": "5b4f337bff4304610483ba67",
      "workspace_roles": [
        "integrator"
      ]
    }
  }
}

Response

Created

metaobject required

Example response

{
  "data": {
    "attributes": {
      "email": "john.doe@gmail.com",
      "roles": [
        "admin"
      ],
      "workspace_id": "5b4f337bff4304610483ba67",
      "workspace_roles": [
        "integrator"
      ]
    }
  }
}