Skip to content

Creating a new Insights Access Group Membership

Request

Adds a user to an Insights Access Group. Only Account Administrators can add users to Insights Access Groups.

This endpoint returns structured Insights Access 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 insights_access_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) - References the associated user.
optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Enum:"user_name""account_permission"
Bodyapplication/jsonrequired
insights_access_group_membershipobject
{
  "insights_access_group_membership": {
    "user_id": 0,
    "insights_access_group_id": 0
  }
}

Responses

Insights Access Group Membership has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
insights_access_group_membershipsobject
usersobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "insights_access_group_memberships": {
    "property1": {
      "account_permission": "string",
      "can_edit": true,
      "created_at": "2019-08-24T14:15:22Z",
      "insights_access_group_id": 0,
      "insights_access_group_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": 0,
      "user_name": "string"
    },
    "property2": {
      "account_permission": "string",
      "can_edit": true,
      "created_at": "2019-08-24T14:15:22Z",
      "insights_access_group_id": 0,
      "insights_access_group_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": 0,
      "user_name": "string"
    }
  },
  "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"
      ]
    }
  }
}