Skip to content

Creating a new User Group Membership

Request

Adds a user to a Workspace Group.

Bulk Create

This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:

{
  "user_group_memberships": [
    {
      "user_id": 123,
      "workspace_group_id": 111
    },
    {
      "user_id": 456,
      "workspace_group_id": 111
    }
  ]
}

This endpoint returns structured User Group Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the user_group_memberships top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - Retrieves the associated user. The response will include user_id, which references the data in the users top-level key.
  • workspace_group (WorkspaceGroup) - Retrieves the associated Workspace Group. The response will include workspace_group_id, which references the data in the workspace_groups top-level key.
Bodyapplication/jsonrequired
user_group_membershipobject
{
  "user_group_membership": {
    "user_id": 0,
    "workspace_group_id": 0
  }
}

Responses

User Group Membership has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
user_group_membershipsobject
usersobject
workspace_groupsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "user_group_memberships": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": 0,
      "user_id": 0,
      "workspace_group_id": 0
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": 0,
      "user_id": 0,
      "workspace_group_id": 0
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "workspace_groups": {
    "property1": {
      "address": "string",
      "company": true,
      "contact_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "notes": "string",
      "phone_number": "string",
      "rate_card_set_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "website": "string",
      "workspace_ids": [
        "string"
      ]
    },
    "property2": {
      "address": "string",
      "company": true,
      "contact_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "notes": "string",
      "phone_number": "string",
      "rate_card_set_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "website": "string",
      "workspace_ids": [
        "string"
      ]
    }
  }
}