Change User Push Notification Settings

Request

The method allows you to change the user's PUSH notification settings. The type of notification to be changed (record_create_online_staff or record_create_online_admin, etc.) should be selected based on the type of notification specified by the user (mode: admin or mode: team_member). Note: 'staff' in notification type names is a legacy term for team member.

Security

BearerPartnerUser

Path

location_idnumberrequired

location ID

user_idnumberrequired

User ID

Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer bearer_token, User user_token

Bodyapplication/jsonrequired

notification_typesArray of objects

Array of objects

Example:

[
  {
    "type": "record_create_online_admin",
    "channels": { … }
  },
  {
    "type": "record_create_offline_admin",
    "channels": { … }
  },
  {
    "type": "record_delete_admin",
    "channels": { … }
  },
  {
    "type": "record_move_admin",
    "channels": { … }
  },
  {
    "type": "license_expire",
    "channels": { … }
  }
]

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/notification_settings/{location_id}/users/{user_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "notification_types": [
      {
        "type": "record_create_online_admin",
        "channels": {
          "push": 1
        }
      },
      {
        "type": "record_create_offline_admin",
        "channels": {
          "push": 1
        }
      },
      {
        "type": "record_delete_admin",
        "channels": {
          "push": 1
        }
      },
      {
        "type": "record_move_admin",
        "channels": {
          "push": 1
        }
      },
      {
        "type": "license_expire",
        "channels": {
          "push": 1
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json

successboolean

Execution success status

Example:true

dataobject

Object with data

Example:

{
  "mode": "staff",
  "notification_types": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

metaArray of objects

Metadata (empty array)

Example:

[]

Response

{
  "success": true,
  "data": {
    "mode": "staff",
    "notification_types": [ … ]
  },
  "meta": []
}