Developer

Delete contact group

Service version: 1
Last edit: 2022.08.30

Purpose

This endpoint uses a command to delete a contact group.

Request data

HTTP method: DELETE

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

URL request format

delete
URL request format
https://{baseURL}/notifications/{versionNumber}/groups/{groupId}?key={Your_API_Key}

curl command request format

delete
curl command request format
curl -v -XDELETE -H 'https://{baseURL}/notifications/{versionNumber}/groups/{groupId}?key={Your_API_Key}'

Request parameters

The following table describes the parameters that can be used in a request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Required parameters

Description

baseURL


string

The base URL for calling the API.


Value: api.tomtom.com

versionNumber


string

Service version number.


Value: 1

key


string

An API Key valid for the requested service.


Value: Your valid API Key.

groupId


string

The contact group id to delete.


Value: UUID

Response data

Response body

Response body format - JSON
1{
2  "id": "object_id",
3  "name": "object_name",
4  "webhookUrls": [],
5  "emails": []
6}

Response fields

The following table describes all of the fields that can appear in a response.

Primary fields

Description

id


string

The UUID of the object.

name


string

(Optional) The name of the object.

webhookUrls


array (string)

The list of URLs to receive message.

emails


array (string)

The list of email addresses to receive message.

Response codes

Code

Meaning & possible causes

200

Deleted

404

Not found : The contact group with the specified id does not exist.

Example

URL request example

delete
URL request example
https://api.tomtom.com/notifications/1/groups/cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d?key={Your_API_Key}

Response body example

Response body example - JSON
1{
2  "id": "cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d",
3  "name": "Alert webhooks",
4  "webhookUrls": [
5    "http://my.page.co/jenkins/0fd2efd6-349c-4990-a340-f0e789bf5a0c",
6    "http://my.page.com/graphana/82402a7a-9f14-4390-9721-c49e3ecb4bcb",
7    "http://my.page.com/alertforwarder/8bfbcf59-7b51-49be-8d87-acea4adfb464"
8  ],
9  "emails": ["john.smith@example.com"]
10}