Sorry, you need to enable JavaScript to visit this website.

Delete contact group

 

Service version: 1
Last edit: 2020.05.21

On this page

Purpose

This endpoint uses a command to delete a contact group.

Request data

HTTP method: DELETE

URL format

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in plain text.
https://baseURL/notifications/versionNumber/groups/groupId?key=Your_API_Key

curl command

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.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
  • The order of Request parameters is not important.
Required parameters
Parameter 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
Optional parameters
This endpoint does not have any optional parameters.

▲ Return to top

Response data

Response body

{
  "id": "object_id",
  "name": "object_name",
  "webhookUrls": [],
  "emails": []
}

Response fields

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

Primary fields
Field 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.

HTTP Response codes

Code Meaning and possible causes
200 Deleted
404 Not found: The contact group with the specified id does not exist.

▲ Return to top

Examples

Request URL

https://api.tomtom.com/notifications/1/groups/cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d?key=Your_API_Key

Response body (JSON)

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

▲ Return to top