---
agentTools:
  projectIndex: https://docs.followupboss.com/llms.txt
---

# /personAttachments/:id

Update an attachment by ID.

[block:callout]
{
  "type": "danger",
  "body": "External systems requesting to hit this endpoint must be registered with Follow Up Boss. To learn more, see the section on [Identification](https://docs.followupboss.com/reference/identification).",
  "title": "Restricted - Registered Systems Only"
}
[/block]

[block:callout]
{
  "type": "warning",
  "body": "The URI should be a link to a file location stored outside of Follow Up Boss. If a URI is not provided, the API will treat the request as an attempt to upload a file to our servers and return a 403.",
  "title": "URI - File Location"
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.followupboss.com/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/personAttachments/{id}": {
      "put": {
        "summary": "/personAttachments/:id",
        "description": "Update an attachment by ID.",
        "operationId": "personattachments-id-put",
        "parameters": [
          {
            "name": "X-System",
            "in": "header",
            "description": "Registered system name.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-System-Key",
            "in": "header",
            "description": "Registered system API key.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "ID of the attachment.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "personId",
                  "uri",
                  "fileName"
                ],
                "properties": {
                  "personId": {
                    "type": "integer",
                    "description": "ID of the person.",
                    "format": "int32"
                  },
                  "uri": {
                    "type": "string",
                    "description": "URI of an externally hosted file."
                  },
                  "fileName": {
                    "type": "string",
                    "description": "Name of the file."
                  },
                  "fileSize": {
                    "type": "integer",
                    "description": "Size of the file in bytes.",
                    "format": "int32"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"personId\": 1,\n    \"fileName\": \"test.jpg\",\n    \"fileSize\": null,\n    \"id\": 2,\n    \"mimeType\": \"link\",\n    \"uri\": \"https://test.com/myfile\",\n    \"thumbnailUri\": null,\n    \"status\": \"created\",\n    \"createdAt\": \"2022-11-16T03:44:52Z\",\n    \"createdById\": 1,\n    \"createdByName\": \"Olivia Admin\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "personId": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "fileName": {
                      "type": "string",
                      "example": "test.jpg"
                    },
                    "fileSize": {},
                    "id": {
                      "type": "integer",
                      "example": 2,
                      "default": 0
                    },
                    "mimeType": {
                      "type": "string",
                      "example": "link"
                    },
                    "uri": {
                      "type": "string",
                      "example": "https://test.com/myfile"
                    },
                    "thumbnailUri": {},
                    "status": {
                      "type": "string",
                      "example": "created"
                    },
                    "createdAt": {
                      "type": "string",
                      "example": "2022-11-16T03:44:52Z"
                    },
                    "createdById": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "createdByName": {
                      "type": "string",
                      "example": "Olivia Admin"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"errorMessage\": \"You do not have access to this API endpoint.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorMessage": {
                      "type": "string",
                      "example": "You do not have access to this API endpoint."
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"errorMessage\": \"Requested resource was not found.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorMessage": {
                      "type": "string",
                      "example": "Requested resource was not found."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "58b53c341065f9c438aa1f7e:6387cab23990a60043e64590"
}
```