Skip to content
Bottle

Allow a driver to take stock

PATCH
/members/{userId}/stock-take-permission
curl --request PATCH \
  --url https://example.com/members/example/stock-take-permission \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "stockTakeAllowed": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
userId
required
string
>= 1 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
stockTakeAllowed
required
boolean

Example generated

{
  "stockTakeAllowed": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Updated

Media typeapplication/json
object
user
required
object
id
required
string
email
required
string format: email
firstName
required
string
lastName
required
string
name
required
string
emailVerified
required
boolean
twoFactorEnabled
required
boolean
twoFactorMethod
required
string | null
Allowed values: totp otp
image
required
string | null
role
required

Owner: billing, deleting the tenant, full control of members. admin: all operational work and may manage drivers and admins. driver: their own round only.

string
Allowed values: owner admin driver technical
stockTakeAllowed
boolean
drivesRounds
boolean
joinedAt
required
string format: date-time

Example 

{
  "user": {
    "id": "kZ8n2xQpR1vLmT4wY7bJc",
    "email": "joe.bloggs@example.com",
    "firstName": "Joe",
    "lastName": "Bloggs",
    "name": "Joe Bloggs",
    "twoFactorMethod": "totp"
  },
  "role": "owner"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or the role is not allowed to do this

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not a driver in this business

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}