latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

workspaces

Adds a user to a specified workspace as a member.

You can add user only from the contract, which current workspace belongs to. A notification email will be sent. The user becomes a member immediately. You need workspaces.workspace.edit or tenant.workspace.edit_membership permissions to access this resource

post/workspaces/{workspace_id}/members

Path parameters

workspace_idstring required

Workspace identifier

Request body

Example request

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "attributes": {
      "roles": [
        "integrator"
      ]
    }
  }
}

Response

metaobject required

Example response

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/members/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "first_name": "John",
      "last_name": "Smith",
      "roles": [
        "owner"
      ],
      "email": "test@example.com"
    }
  }
}