POST api/CommunicationKeys

Creates a new communication key.

Request Information

URI Parameters

None.

Body Parameters

Data to use for the new communication key.

NewCommunicationKey

Name	Description	Type	Additional information
Name	The name of the communication key.	string	Max length: 256 Min length: 1
Data	The communication key. If not specified, it will be generated.	Collection of byte	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. If not specified, it will be generated.

Collection of byte

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:

Created (201) - The communication key is successfully added.
BadRequest (400) - The data for a new communication key is invalid.

Response Formats

application/json, text/json

Sample:

{
  "Id": "586fc501-a78a-4c2d-84e4-3046c4b5f22e",
  "Name": "sample string 2",
  "Data": "QEA=",
  "Created": "2024-09-10T06:52:02.0449892+00:00",
  "Updated": "2024-09-10T06:52:02.0606493+00:00"
}