Enable browser notifications for my current session and business

PUT

/browser-push/subscription

curl --request PUT \
  --url https://example.com/browser-push/subscription \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "endpoint": "example", "keys": { "p256dh": "example", "auth": "example" } }'

Authorizations

• sessionCookie
  tenant:read
• apiKey
  tenant:read

Request Body^required

Media typeapplication/json

object

endpoint

required

string

<= 4096 characters

keys

required

object

p256dh

required

string

/^[A-Za-z0-9_-]{87}={0,2}$/

auth

required

string

/^[A-Za-z0-9_-]{22}={0,2}$/

Example ^generated

{
  "endpoint": "example",
  "keys": {
    "p256dh": "example",
    "auth": "example"
  }
}

Responses

204

Registered

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

403

Sessions only; no support impersonation

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

409

Browser subscription limit reached

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

422

Invalid push subscription

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"
    }
  ]
}

503

Browser push is not configured

Media typeapplication/json

object

error

required

string

message

required

string

Example

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