Update a metadata value.

Updates the value for the specified metadata key.
Note that you are not allowed to enter any personal data relating to end users or any third parties.

Path Parameters

• id string required

  Possible values: Value must match regular expression ^[85,97]{2}[23456789ABCDEFGHJKLMNPQRSTUVWXYZ]{16}$

  IoT subscription ID to perform request on.

• key string required

  Possible values: <= 100 characters

  The metadata key to update.

application/json

Request Body required

Specifies the new metadata value to update to.

• value string required

  Possible values: non-empty and <= 100 characters

  The metadata value

Responses

• 204
• 400
• 401
• 403
• 404
• 500

---

Metadata updated successfully.

BadRequest

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Unauthorized. Your token is not valid.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Forbidden. You are not allowed to access the requested resource.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

The specified resource was not found

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Internal Server Error

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Loading...