Skip to main content

Create Access Group

POST 

https://api.staging.powerapi.com/api/v1/access_groups

Create Access Group

Request

Body

required

    data

    object

    required

    type stringrequired

    Possible values: [access_groups]

    attributes

    object

    name stringrequired

    relationships

    object

    businesses

    object

    data

    object[]

    required

  • Array [

  • type stringrequired

    Possible values: [businesses]

    id stringrequired
  • ]

  • users

    object

    data

    object[]

    required

  • Array [

  • type stringrequired

    Possible values: [users]

    id stringrequired
  • ]

Responses

Create access group in organisation

Schema

    data

    object

    required

    id stringrequired
    type stringrequired

    Possible values: [access_groups]

    links

    object

    required

    self stringrequired

    attributes

    object

    required

    name stringrequired

Request Collapse all
Base URL
https://api.staging.powerapi.com
Auth
Body required
{
  "data": {
    "type": "access_groups",
    "attributes": {
      "name": "string"
    },
    "relationships": {
      "businesses": {
        "data": [
          {
            "type": "businesses",
            "id": "string"
          }
        ]
      },
      "users": {
        "data": [
          {
            "type": "users",
            "id": "string"
          }
        ]
      }
    }
  }
}
ResponseClear

Click the Send API Request button above and see the response here!