Skip to main content
PATCH
/
api
/
v1
/
workspaces
/
{workspace_slug}
/
projects
/
{project_id}
/
work-items
/
{work_item_id}
/
attachments
/
{attachment_id}
/
Update an attachment
curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{attachment_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "attributes": {},
  "asset": "<string>",
  "entity_type": "<string>",
  "entity_identifier": "<string>",
  "is_deleted": true,
  "is_archived": true,
  "external_id": "<string>",
  "external_source": "<string>",
  "size": 123,
  "is_uploaded": true,
  "storage_metadata": {}
}'

​
Path parameters

​
workspace_slug
string
required
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.
​
project_id
string
required
The unique identifier of the project.
​
work_item_id
string
required
The unique identifier of the work item.
​
attachment_id
string
required
The unique identifier of the attachment.

​
Body parameters

​
attributes
object
File metadata object containing name, size, and type.
​
asset
string
Storage path/identifier for the attachment file.
​
entity_type
string
Entity type of the attachment.
​
entity_identifier
string
Entity identifier for the attachment.
​
is_deleted
boolean
Whether the attachment has been deleted.
​
is_archived
boolean
Whether the attachment has been archived.
​
external_id
string
External identifier if the attachment is imported to Plane.
​
external_source
string
Name of the source if the attachment is imported to Plane.
​
size
number
File size in bytes.
​
is_uploaded
boolean
Whether the file has been successfully uploaded.
​
storage_metadata
object
Cloud storage metadata.