Edit Session Metadata

Edits the metadata for the session.

Caution

Partial updates are not supported. The full metadata set submitted in the request will replace the full previous metadata set.

Authorizations: Sessions - EDIT

Requests

PUT /apis/sessions/:sessionId/metadata

[
    {
      "name": "calypso:creator",
      "field": [
        {
          "fieldType": "STRING",
          "valueString": "haiadmin7"
        }
      ]
    },
    {
      "name": "calypso:category:Locations",
      "field": [
        {
          "fieldType": "STRING",
          "valueString": "Montreal"
        }
      ]
    },
    {
      "name": "calypso:recording",
      "field": [
        {
          "fieldType": "STRING",
          "valueString": "6d736ffb-50a2-4068-ad2e- cc147258b3f5"
        }
      ]
    },
    {
      "name": "calypso:creatorDisplayName",
      "field": [
        {
          "fieldType": "STRING",
          "valueString": "haiadmin"
        }
      ]
    }
  ]

Response

Success

{
  "data": [
    {
      "name": "calypso:creator",
      "field": [
        {
          "fieldType": "STRING",
          "valueString": "haiadmin7"
        }
      ]
    },
    {
      "name": "calypso:category:Locations",
      "field": [
        {
          "fieldType": "STRING",
          "valueString": "Montreal"
        }
      ]
    },
    {
      "name": "calypso:recording",
      "field": [
        {
          "fieldType": "STRING",
          "valueString": "6d736ffb-50a2-4068-ad2e- cc147258b3f5"
        }
      ]
    }
  ]
}

Error

Code	Payload	Description
400	{"code":"010001", "name":"InputValidation", "message":<Error message>, "httpStatusCode":400}	Supplied data was insufficient or incorrect.
404	{"code":"040006", "name":"SessionNotFound", "message":"Session not found","httpStatusCode":404}	Session with UUID `sessionId` not found.