# UpdateProjectWorkspaceNote

## Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

### Headers

```
PUT /api/ss/project/:id/workspace/note/:noteId HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
```

### Query

**id (string)**

Id of the project.

Example:

```
PUT /api/ss/project/5f63de24fa1c9208d3e140b0/workspace/note/:noteId HTTP/1.1
```

**noteId (string)**

Id of the note.

Example:

```
PUT /api/ss/project/:id/workspace/note/5fd2b313ee79ce0a79f213c1 HTTP/1.1
```

**title (string) (optional)**

Title of the note.

Example:

```
{
   "title": "..."
}
```

**details (string) (optional)**

Details of the note.

Example:

```
{
   "details": "..."
}
```

**details\_type (string) (optional)**

Must be either PLAINTEXT or RICHTEXT. Defaults to PLAINTEXT if not specified.

Example:

```
{
   "details_type": "PLAINTEXT"
}
```

**assets (array of strings) (optional)**

Asset IDs for each asset on the project which is linked to the note.

Example:

```
{
   "assets": ["5fd2aa6b82fba0091dee695b", "5f6ae8b97b1bc80867f90301"]
}
```

**is\_deleted (boolean) (optional)**

Whether note is deleted or not.

Example:

```
{
   "is_deleted": false
}
```

## Example

The following example is a cURL request to update an existing workspace note for a project.

### Request

Include API Token instead of stars in 'X-SSAPI-KEY: \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*' parameter.

```
curl -X PUT 'https://demo.attackforge.com/api/ss/project/5f63de24fa1c9208d3e140b0/workspace/note/5fd2b313ee79ce0a79f213c1' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "title": "Updated Note",
  "details": "Here are some updated note details",
  "details_type": "PLAINTEXT",
  "assets": ["5fd2aa6b82fba0091dee695b"],
  "is_deleted": false
}'
```

### Response

Response contains a result.

```
{
   "result": "Successfully Updated Project Workspace Note"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/updateprojectworkspacenote.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.