light-mode-image
Learn
MATTR VII PlatformInboxes

Update an inbox

Update the inbox configurations

Roles

adminissuer
PUT/v1/messaging/inboxes/{id}
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Inbox ID

Updates an inbox name.

Analytic events

  • MESSAGING_INBOX_UPDATE_START
  • MESSAGING_INBOX_UPDATE_SUCCESS
  • MESSAGING_INBOX_UPDATE_FAIL
namestring
Length1 <= length

Response Body

curl -X PUT "https://example.vii.au01.mattr.global/v1/messaging/inboxes/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
  "name": "My_Inbox"
}

{
  "code": "BadRequest",
  "message": "Validation Error",
  "details": [
    {
      "value": "notUUIDvalue",
      "msg": "Invalid value",
      "param": "inboxId",
      "location": "params"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?