Specialized APIsSensor InsightsAPI Reference

Add users to a notification group

POST /dm/v1/notificationGroups/actions/add-users

Use this endpoint to add users to a notification group.

Header Parameters

The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.

Parameter NameData TypeDescription
Authorization (required)stringHTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token}
VZ-M2M-Token (required)stringA valid session token returned by a Connectivity Management POST /session/login request.
Content-Type (required)stringMust be application/json.

HTTP Request

POST https://thingspace.verizon.com/api/dm/v1/notificationGroups/actions/add-users

Request Parameters

Note: All parameters are required unless marked (optional)

ParameterData TypeDescription
accountnamestringThe numeric name of the account and must include leading zeros.
idstringThe UUID of the resource. A UUID is a 34 or 36-bit alphanumeric value.
useridsarrayAn array of the user profile IDs to add to the group.

Request Body

Example Request:

{
  "accountname": "0000123456-00001",
  "id": "45f1a56e-eeee-ffff-gggg-68cb994feb5f",
  "userids": [
    "ee70a869-eeee-ffff-gggg-07c14c31f96e",
    "131501ff-eeee-ffff-gggg-647d19179a12"
  ]
}

Success Response

Status 200 This is a synchronous response, but there is no response body. Only an HTML 200 will be returned.

Success Parameters

None

Failure Responses

Example Response:

{
  "error": "Error name or code",
  "error_description": "A longer error description.",
  "cause": "A cause for the error"
}

On this page