BIbigchange
Attachments

Create an attachment

Changed on

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

post/v1/attachments

Request

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

Headers

Customer-Idinteger required

The customer identifier

Request body multipart/form-data

filestring 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>

entityIdinteger required

The unique identifier of the entity the attachment should be associated with

isResourceVisibleboolean

Whether the attachment should be visible to resources (mobile field engineers)

Example request

{
  "entityType": "job",
  "entityId": 5514123
}

Response

Created

idinteger

Identifier of the newly created record

Changes