Sign in
Attachments

Update attachment

Updates an attachment. Requires board editor permissions.

patch/attachments/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/attachments/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idstring required
Example:1357158568008091264

ID of the attachment to update

Request body

namestring

Name/title of the attachment

Example request

{
  "name": "Important Attachment"
}

Response

Attachment updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "cardId": "1357158568008091265",
    "creatorUserId": "1357158568008091266",
    "type": "link",
    "data": {
      "url": "https://google.com/search?q=planka",
      "faviconUrl": "https://storage.example.com/favicons/google.com.png"
    },
    "name": "Important Attachment",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.