Create User in organisation

POST 
/api/v1/organisations/me/users

Businesses can be associated directly only for business managers, for group managers use access groups

Request

application/vnd.api+json

Body

required

data

object

required

type stringrequired

Possible values: [users]

attributes

object

name stringrequired

email stringrequired

language stringrequired

permissions_role stringrequired

Possible values: [admin, group_manager, business_manager]

invitation boolean

password string

Preset password for the user, if invitation is not used (mutually exclusive)

password_confirmation string

relationships

object

businesses

object

data

object[]

Array [

type stringrequired

Possible values: [businesses]

id stringrequired

]

access_groups

object

data

object[]

Array [

type stringrequired

Possible values: [access_groups]

id stringrequired

]

Responses

201

Create User in organisation

application/vnd.api+json

Schema

Schema

data

object

required

id stringrequired

type stringrequired

Possible values: [users]

links

object

required

self stringrequired

attributes

object

required

accepted-food-detective boolean

allergies string

avatar

object

url stringrequired

birthday string

city string

confirmed boolean

connected-to-partoo boolean

country string

country-code string

deleted boolean

detected-language

email string

favourite-drink string

favourite-food string

food-detective-status string

gender string

invitation-accepted-at string

invited-at string

language string

monthly-bars-budget number

monthly-delivery-takeaway-budget number

monthly-restaurants-budget number

name string

partoo-user-id string

permissions-role string

phone string

phone-country-code string

phone-country-prefix string

post-code string

recovery-email string

region

region-code string

registered-via-oauth boolean

reviews-count number

role string

sign-in-count number

street string

street-number string

subscription-not-terminated boolean

unconfirmed-email string

relationships

object

required

specializations

object

required

links

object

required

self stringrequired

related stringrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "users",
    "links": {
      "self": "string"
    },
    "attributes": {
      "accepted-food-detective": true,
      "allergies": "string",
      "avatar": {
        "url": "string"
      },
      "birthday": "string",
      "city": "string",
      "confirmed": true,
      "connected-to-partoo": true,
      "country": "string",
      "country-code": "string",
      "deleted": true,
      "detected-language": {},
      "email": "string",
      "favourite-drink": "string",
      "favourite-food": "string",
      "food-detective-status": "string",
      "gender": "string",
      "invitation-accepted-at": "string",
      "invited-at": "string",
      "language": "string",
      "monthly-bars-budget": 0,
      "monthly-delivery-takeaway-budget": 0,
      "monthly-restaurants-budget": 0,
      "name": "string",
      "partoo-user-id": "string",
      "permissions-role": "string",
      "phone": "string",
      "phone-country-code": "string",
      "phone-country-prefix": "string",
      "post-code": "string",
      "recovery-email": "string",
      "region": {},
      "region-code": "string",
      "registered-via-oauth": true,
      "reviews-count": 0,
      "role": "string",
      "sign-in-count": 0,
      "street": "string",
      "street-number": "string",
      "subscription-not-terminated": true,
      "unconfirmed-email": "string"
    },
    "relationships": {
      "specializations": {
        "links": {
          "self": "string",
          "related": "string"
        }
      }
    }
  }
}

Loading...