---
agentTools:
  projectIndex: https://financial-cloud.readme.io/llms.txt
---

# Update the status of a dashboard entry

Update the current status of the dashboard entry to the one provided

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Dashboards",
    "version": "3.0.2",
    "contact": {
      "name": "Grant Thompson",
      "email": "grant.thompson@financial-cloud.co.uk"
    },
    "description": "This API allows you to interact with the dashboards service both in terms of managing dashboards but also in terms of managing the dashboard entries that live on the dashboards."
  },
  "servers": [
    {
      "url": "http://localhost:8080",
      "description": "localhost"
    },
    {
      "url": "https://api.glabs.financial-cloud.co.uk/dashboards-new",
      "description": "Glabs Dev"
    }
  ],
  "tags": [
    {
      "name": "Dashboard operations"
    }
  ],
  "paths": {
    "/{dashboardUUID}/{dashboardEntryUUID}/status": {
      "parameters": [
        {
          "schema": {
            "type": "string"
          },
          "name": "dashboardUUID",
          "in": "path",
          "required": true,
          "description": "The UUID of the dashboard who's entries you want to update the status of",
          "example": "59a25657-4424-4d61-b530-950c3cbb0a38"
        },
        {
          "schema": {
            "type": "string"
          },
          "name": "dashboardEntryUUID",
          "in": "path",
          "required": true,
          "description": "The UUID of the dashboard entry who's status you want to update.",
          "example": "59a25657-4424-4d61-b530-950c3cbb0a38"
        }
      ],
      "put": {
        "summary": "Update the status of a dashboard entry",
        "operationId": "put-entry-status",
        "x-eov-operation-id": "put-entry-status",
        "x-eov-operation-handler": "handlers/dashboards",
        "description": "Update the current status of the dashboard entry to the one provided",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DashboardEntryModel"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Bad-Request"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "status": {
                    "type": "string",
                    "maxLength": 50,
                    "example": "pending",
                    "description": "The status to assign to the dashboard entry."
                  }
                },
                "required": [
                  "status"
                ]
              }
            }
          }
        },
        "tags": [
          "Dashboard operations"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "DashboardEntryModel": {
        "description": "The complete dashboard entry that will be returned upon the successful completion of most dashboard entry operations",
        "type": "object",
        "title": "Dashboard entry model",
        "x-tags": [
          "Responses"
        ],
        "properties": {
          "_id": {
            "type": "string",
            "minLength": 1
          },
          "currentStatus": {
            "type": "object",
            "required": [
              "status",
              "date"
            ],
            "properties": {
              "status": {
                "type": "string",
                "minLength": 1,
                "description": "The status of the dashboard entry"
              },
              "date": {
                "type": "string",
                "minLength": 1,
                "description": "The date of the status"
              }
            }
          },
          "currentDashboards": {
            "type": "array",
            "description": "An array of dashboards that this entry currently exists on",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "description": "An array of tags associated with this entry",
            "items": {
              "type": "string"
            }
          },
          "allAgentsInvolved": {
            "type": "array",
            "description": "An array of agents that have been involved somehow in this entry",
            "items": {
              "$ref": "#/components/schemas/DashboardAgentInformationModel"
            }
          },
          "currentlyAssignedAgents": {
            "type": "array",
            "description": "An array of agents that are currently assigned to this entry",
            "items": {
              "$ref": "#/components/schemas/DashboardAgentInformationModel"
            }
          },
          "entryType": {
            "type": "string",
            "minLength": 1,
            "description": "The kind of entry you are creating"
          },
          "payload": {
            "description": "",
            "oneOf": [
              {
                "$ref": "#/components/schemas/DashboardContentBase"
              },
              {
                "$ref": "#/components/schemas/DashboardContentCallback"
              },
              {
                "$ref": "#/components/schemas/DashboardContentEmail"
              },
              {
                "$ref": "#/components/schemas/DashboardContentContract"
              }
            ]
          },
          "history": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
              "type": "object",
              "properties": {
                "_id": {
                  "type": "string",
                  "minLength": 1
                },
                "kind": {
                  "type": "string",
                  "minLength": 1,
                  "description": "The kind of history item"
                },
                "message": {
                  "type": "string",
                  "minLength": 1,
                  "description": "The history message"
                },
                "user": {
                  "$ref": "#/components/schemas/DashboardAgentInformationModel"
                },
                "date": {
                  "type": "string",
                  "minLength": 1,
                  "description": "The date of the history item"
                },
                "serviceName": {
                  "type": "string",
                  "description": "The service name if this action wasn't a user"
                }
              },
              "required": [
                "_id",
                "kind",
                "message",
                "date"
              ]
            }
          },
          "date": {
            "type": "string",
            "minLength": 1,
            "description": "The date that the dashboard entry was created"
          },
          "UUID": {
            "type": "string",
            "minLength": 1,
            "description": "The UUID of this dashboard entry"
          },
          "lastUpdatedDate": {
            "type": "string",
            "minLength": 1,
            "description": "The last updated date of this dashboard entry"
          },
          "FCCID": {
            "type": "string",
            "minLength": 1,
            "description": "The FCCID of the customer that this dashboard entry is assigned to",
            "oneOf": [
              {
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
              },
              {
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-5[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
              }
            ],
            "example": "9b7920e8-2fc2-4f9c-8b29-6f0343a3e4cf"
          },
          "dueDate": {
            "type": "string",
            "minLength": 1,
            "description": "The dueDate of this dashboard entry",
            "example": "2020-11-02T20:53:05.960Z"
          },
          "flowName": {
            "type": "string",
            "minLength": 1,
            "description": "The flow name of this dashboard entry",
            "example": "flowName"
          },
          "flowUUID": {
            "type": "string",
            "minLength": 1,
            "description": "The flow UUID of this dashboard entry",
            "example": "9b7920e8-2fc2-4f9c-8b29-6f0343a3e4cf"
          },
          "customerMeta": {
            "type": "object",
            "description": "The customer meta data - if we had the information available at save time",
            "properties": {
              "title": {
                "type": "string",
                "description": "The title of the customer",
                "example": "Miss"
              },
              "firstName": {
                "type": "string",
                "description": "The forename of the customer",
                "example": "Taylor"
              },
              "lastName": {
                "type": "string",
                "description": "The surname of the customer",
                "example": "Swift"
              }
            }
          }
        },
        "required": [
          "_id",
          "currentStatus",
          "currentDashboards",
          "tags",
          "allAgentsInvolved",
          "currentlyAssignedAgents",
          "entryType",
          "history",
          "date",
          "UUID",
          "lastUpdatedDate"
        ]
      },
      "DashboardAgentInformationModel": {
        "description": "This is the information that you will get back where agents of the system are involved (similar to the matrix - but not as cool)",
        "type": "object",
        "x-examples": {
          "example": {
            "UUID": "2714c420-5382-4dd2-a473-827353a402e9",
            "firstName": "Taylor",
            "lastName": "Swift"
          }
        },
        "properties": {
          "UUID": {
            "type": "string",
            "description": "The UUID of the agent",
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "firstName": {
            "type": "string",
            "minLength": 1,
            "description": "The first name of the agent"
          },
          "lastName": {
            "type": "string",
            "minLength": 1,
            "description": "The last name of the agent"
          }
        },
        "required": [
          "UUID",
          "firstName",
          "lastName"
        ],
        "title": "Dashboard Agent Information Model"
      },
      "DashboardContentBase": {
        "title": "'base item' dashboard payload",
        "type": "object",
        "description": "The content for the payload item in the response for any particular dashboard item.\n\nThis represents the minimum that you will receive",
        "properties": {
          "note": {
            "type": "string",
            "description": "The 'note' for the base item"
          },
          "actionDate": {
            "type": "string",
            "format": "date-time",
            "description": "The date for the base item"
          }
        },
        "required": [
          "note"
        ],
        "x-tags": [
          "dashboard payload content"
        ]
      },
      "DashboardContentCallback": {
        "title": "'callback item' dashboard payload",
        "type": "object",
        "description": "The content for the payload item in the response for any dashboard item of type 'callback'\n\nThis represents the minimum that you will receive",
        "properties": {
          "note": {
            "type": "string",
            "description": "The note for the callback dashboard entry"
          },
          "actionDate": {
            "type": "string",
            "format": "date-time",
            "description": "The actionDate for the callback dashboard item ( this is the dueDate)"
          }
        },
        "required": [
          "note",
          "actionDate"
        ],
        "x-tags": [
          "dashboard payload content"
        ]
      },
      "DashboardContentEmail": {
        "description": "The content for the payload item in the response for any dashboard item of type 'email'\n",
        "type": "object",
        "title": "'email item' dashboard payload",
        "x-tags": [
          "dashboard payload content"
        ],
        "properties": {
          "subject": {
            "type": "string",
            "description": "The subject of the email"
          },
          "from": {
            "type": "array",
            "description": "the email address the item came from, formatted nicely if possible",
            "items": {
              "$ref": "#/components/schemas/DashboardEmailContact"
            }
          },
          "to": {
            "type": "array",
            "description": "an array of the receipient email address, formatted nicely if possible",
            "items": {
              "$ref": "#/components/schemas/DashboardEmailContact"
            }
          },
          "cc": {
            "type": "array",
            "description": "an array of the receipient email address that were a CC, formatted nicely if possible",
            "items": {
              "$ref": "#/components/schemas/DashboardEmailContact"
            }
          },
          "replyTo": {
            "type": "array",
            "description": "An array of the reply to address(s)",
            "items": {
              "$ref": "#/components/schemas/DashboardEmailContact"
            }
          },
          "priority": {
            "type": "string",
            "description": "the priority of the email ( high, normal, low)"
          },
          "rawFileKey": {
            "type": "string",
            "description": "the key linking this entry to the raw email received folder: 'email/inbound'"
          },
          "attachments": {
            "type": "array",
            "description": "An array of attachments that this email has",
            "items": {
              "type": "object",
              "properties": {
                "filename": {
                  "type": "string",
                  "description": "The original filename of the attachment"
                },
                "key": {
                  "type": "string",
                  "description": "the key of the attachment (folder: 'email/attachments')"
                }
              },
              "required": [
                "filename",
                "key"
              ]
            }
          },
          "actionDate": {
            "type": "string",
            "format": "date-time",
            "description": "The actionDate for this email - we could use this in the future for SLA"
          }
        },
        "required": [
          "subject",
          "from",
          "to",
          "cc",
          "replyTo",
          "rawFileKey",
          "attachments",
          "actionDate"
        ]
      },
      "DashboardContentContract": {
        "title": "'contract item' dashboard payload",
        "type": "object",
        "description": "The content for the payload item in the response for any dashboard item of type 'contract'",
        "properties": {
          "note": {
            "type": "string",
            "description": "The note for the contract dashboard entry"
          },
          "actionDate": {
            "type": "string",
            "format": "date-time",
            "description": "The actionDate for the contract dashboard item"
          }
        },
        "required": [
          "note"
        ],
        "x-tags": [
          "dashboard payload content"
        ]
      },
      "DashboardEmailContact": {
        "title": "DashboardEmailContact",
        "type": "object",
        "description": "The format that you recieve email addresses in",
        "properties": {
          "address": {
            "type": "string",
            "description": "The email address"
          },
          "name": {
            "type": "string",
            "description": "The name part of the email/group - may be blank"
          }
        },
        "required": [
          "address",
          "name"
        ],
        "x-examples": {
          "example-1": {
            "address": "grant.thompson@financial-cloud.co.uk",
            "name": "Grant Thompson"
          }
        }
      }
    },
    "responses": {
      "Bad-Request": {
        "description": "This is a 400 bad request response",
        "content": {
          "application/json": {
            "schema": {
              "description": "",
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "minLength": 1
                }
              },
              "required": [
                "message"
              ],
              "x-examples": {
                "example-1": {
                  "message": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 101,
      "1": 35,
      "2": 205,
      "3": 159,
      "4": 57,
      "5": 120,
      "6": 250,
      "7": 0,
      "8": 32,
      "9": 112,
      "10": 211,
      "11": 24
    }
  }
}
```