# Create a Notification Group ### `POST /dm/v1/notificationGroups` Use this endpoint to create a notification group based on existing user records. ## 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](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/getting-started/introduction-to-the-connectivity-management-api). |Parameter Name|Data Type|Description| |-----|-----|-----| | **Authorization** *(required)* | string | HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** *(required)* | string | A valid session token returned by a Connectivity Management `POST /session/login` request. | | **Content-Type** *(required)* | string | Must be `application/json`. | ## HTTP Request [POST https://thingspace.verizon.com/api/dm/v1/notificationGroups](/docs/specialized-apis/sensor-insights/api-endpoints/notification-groups/sensorinsightscreatenotificationgrouprequest) ## Request Parameters **Note:** All parameters are required unless marked *(optional)* | Parameter | Data Type | Description | | ---------- | --------- | ------------ | | **accountname** | string | The numeric name of the account and must include leading zeros. | | **group** |object| An object containing the group details.| | **description** |string| A description of the group. | | **groupemail** |string| The email address used to reach all the members of the group, in the format "<email@domain.com>".| | **name** |string| The user defined name of the group.| | **userids** |array| An array of the user profile IDs to add to the group as members.| ## Request Body Example Request: ```json { "accountname": "0000123456-00001", "group": { "description": "a short description", "groupemail": "email@domain.com", "name": "User defined name of the group" }, "userids": [ "ee70a869-eeee-ffff-gggg-07c14c31f96e", "131501ff-eeee-ffff-gggg-647d19179a12" ] } ``` ## Success Response **Status 200** This is a synchronous response, so the group details and all the user details will be returned. Example Response: ```json { "createdon": "2023-10-02T15:46:34.562Z", "description": "a short description", "foreignid": "c1f178d3-eeee-ffff-gggg-0d6b7ae6022a", "groupemail": "email@domain.com", "id": "The UUID of the resource record", "lastupdated": "2023-10-02T15:46:34.562Z", "name": "User defined name of the group", "users": [ { "email": "email@domain.com", "firstname": "First name", "lastname": "Last name or Surname", "mdn": "908-555-1234", "customdata": { "additionalProp1": [ 100 ], "additionalProp2": [ 100 ], "additionalProp3": [ 100 ] } } ], "version": "1.0", "versionid": "337bd2e8-eeee-ffff-gggg-5207992fd395" } ``` ## Success Parameters | Parameter | Data Type | Description | | ---------- | -------- | ----------- | | **createdon** |string ($date-time)|The timestamp of when the record was created. | | **description** |string| A description of the group. | | **foreignid** |string| The UUID value of the user's Enterprise Customer Profile Database (ECPD) account. A UUID is a 32 to 36-bit alphanumeric string.| | **groupemail** |string|The email address used to reach all the members of the group.| | **id** |string| The UUID of the resource record. A UUID is a 32 to 36-bit alphanumeric string. | | **lastupdated** |string ($date-time)|The timestamp of when the last update to the record was made.| | **name** |string|The user defined name of the group.| | **user** |object|An object containing the details of the user.| | **email** |string|An email address for the user, in the format "<email@domain.com>".| | **firstname** |string|The user's first name| | **lastname** |string|The user's last name or Surname.| | **mdn** |string|The Mobile Directory Number of the user. This is a 10-digit phone number.| | **customdata** |object| This is free form JSON, any thing in the form of JSON can be stored. | | **version** |string| The resource version. | | **versionid** |string| The UUID of the resource version. A UUID is a 32 to 36-bit alphanumeric string. | ## Failure Responses Example Response: ```json { "error": "Error name or code", "error_description": "A longer error description.", "cause": "A cause for the error" } ```