Delete a group

This DELETE operation deletes a group from the SQS based on the group id. If successful, you receive an HTTP response code of 204.

See HTTP response codes for other response codes.

DELETE /sqs/api/groups/<id>

HEADER INFO

authorisation: HTTP Basic Auth

tenant: <tenantName>

permissions: SQS_GROUP_DELETE_PERMISSION

URL parameters

Parameter	Description
`id`	The auto-assigned identifier that was given to the group upon creation.

Code Description

201/204

success!

If you receive a 204 code, you will not see a JSON response.

207

Multistatus response

Check out HTTP statuses for more details.

This is not applicable to all operations.

400

malformed request

401

unauthorised; bad username or password

403

forbidden; user does not have appropriate privileges

404

group not found

409

conflict with target resource

This often occurs if the item already exists, such as a plan, group, or name.

This is not applicable to all operations.

412

failed validation; this typically means that a property was not set or a value is out of range.

example

HTTP 412
{
  "errors" : [
        {
          "field" : "name",
          "description" : "name is mandatory"
        }
    ]
}

422

failed processing (after passing validation).

example

HTTP 422
{
    "message": "Subscriber max plan count exceeded",
    "errorCode": 1
}

Example 1. SQS response codes

500

internal error

503

request rejected due to overload