PUT api/CommunicationKeys/{id}

Updates a communication key.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the communication key to update.	globally unique identifier	Required

Body Parameters

The new data for the communication key.

UpdatedCommunicationKey

Name	Description	Type	Additional information
Name	The name of the communication key.	string	Max length: 256 Min length: 1
Data	The communication key.	Collection of byte	Required Max length: 32 Min length: 32

Name

Description

Type

Additional information

Name

The name of the communication key.

string

Max length: 256

Min length: 1

Data

The communication key.

Collection of byte

Required

Max length: 32

Min length: 32

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Data": "QEA="
}

Response Information

Resource Description

CommunicationKey

Name	Description	Type	Additional information
Id	The ID of the communication key.	globally unique identifier	Required
Name	The name of the communication key.	string	Max length: 256 Min length: 1
Data	The communication key.	Collection of byte	Required Max length: 32 Min length: 32
Created	The date when the communication key was created (in the ISO 8601 format).	date	Required
Updated	The date when the communication key was updated last time (in the ISO 8601 format).	date	None.

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

OK (200) - The communication key is successfully updated.
BadRequest (400) - The ID of the communication key or the updated data for the communication key is invalid.
NotFound (404) - The communication key with the specified ID is not found.

Response Formats

application/json, text/json

Sample:

{
  "Id": "b61c81dd-fde3-4bd2-9fae-858561f12e44",
  "Name": "sample string 2",
  "Data": "QEA=",
  "Created": "2024-09-11T10:50:59.6516461+00:00",
  "Updated": "2024-09-11T10:50:59.6516461+00:00"
}