---
title: "Create an attachment"
method: POST
path: "/v1/attachments"
tags: ["Attachments"]
---

# Create an attachment

`POST /v1/attachments`

## Request

- Base URL: `https://api.bigchange.com`
- URL: `https://api.bigchange.com/v1/attachments`
- Auth: HTTP bearer

Creates a new attachment against the specified entity. Supported entity types are `Job`, `JobGroup`, `ContactNote`, `SalesOpportunity`, `WorksheetAnswer` and `InvoiceAttachment` (required scope attachments:write)

## Headers

- `Customer-Id` integer, required

## Request body `multipart/form-data`

- object
  - `file` string, binary, required: The file to upload
  - `entityType` 'job' | 'worksheetAnswer' | 'contactNote' | 'invoice' | 'contact' | 'jobGroup' | 'salesOpportunity' | 'invoiceAttachment', required: The type of entity an attachment is associated with<p>Possible values:</p><ul><li><b>job</b>: Associated with a job entity</li><li><b>worksheetAnswer</b>: Associated with a worksheet answer entity</li><li><b>contactNote</b>: Associated with a contact note entity</li><li><b>invoice</b>: Associated with an invoice entity</li><li><b>contact</b>: Associated with a contact entity</li><li><b>jobGroup</b>: Associated with a job group entity</li><li><b>salesOpportunity</b>: Associated with a sales opportunity entity</li><li><b>invoiceAttachment</b>: Associated with an invoice attachment entity</li></ul>
  - `entityId` integer, required: The unique identifier of the entity the attachment should be associated with
  - `isResourceVisible` boolean: Whether the attachment should be visible to resources (mobile field engineers)

## Response `201`

Created

- PostResponseInt64: Represents a response for a POST request, containing the ID of the newly created record
  - `id` integer: Identifier of the newly created record

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Content
- `500`: Internal Server Error

## Changes

- **2026-10-22** `e91e0c534929`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bigchange/apis/bigchange-dx/changes/v1/attachments/post.md)

---

[API](https://skmtc.dev/bigchange/apis/bigchange-dx.md) - [All operations](https://skmtc.dev/bigchange/apis/bigchange-dx/llms.txt) - [OpenAPI document](https://skmtc.dev/bigchange/apis/bigchange-dx/revisions/b262bfdb1dd0?raw)