Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateMulticastGroup

Updates properties of a multicast group session.

Request Syntax


PATCH /multicast-groups/Id HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "LoRaWAN": { 
      "DlClass": "string",
      "ParticipatingGateways": { 
         "GatewayList": [ "string" ],
         "TransmissionInterval": number
      },
      "RfRegion": "string"
   },
   "Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Id

The ID of the multicast group.

Length Constraints: Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The description of the new resource.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

LoRaWAN

The LoRaWAN information that is to be used with the multicast group.

Type: LoRaWANMulticast object

Required: No

Name

The name of the multicast group.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

ConflictException

Adding, updating, or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400