End a support session

POST

/console/support-sessions/{id}/end

curl --request POST \
  --url https://example.com/console/support-sessions/example/end \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "reason": "example" }'

Signs the member of staff out of the business at once, with the reason recorded as support.session_ended. Your own session, or anybody’s for a console owner.

Authorizations

• consoleRole
  support

Parameters

Path Parameters

id

required

string

>= 1 characters

Request Body^required

Media typeapplication/json

object

reason

required

string

>= 5 characters <= 500 characters

Example^generated

{
  "reason": "example"
}

Responses

204

Ended

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

403

Not Bottle staff, no two-step sign-in, or a console role too low for this

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

404

Not found

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

409

Somebody else’s, without a console owner

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

422

Validation failed

Media typeapplication/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}