Create a new Attachment

post

https://api.servicem8.com/api_1.0/attachment.json

OAuth Scope

This endpoint requires the following OAuth scope manage_attachments.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

Body Params

Attachment record to create

related_object

string

The type of object this attachment is related to (e.g., 'job', 'company', 'staff'). Must be a valid object type. Always stored in lowercase.

related_object_uuid

uuid

UUID of the related object to which this attachment belongs. Must be a valid UUID of an existing object of the type specified in the related_object field.

attachment_name

string

length ≤ 127

The security roles description

file_type

string

length ≤ 50

Location's name

attachment_source

string

Indicates the source or type of the attachment (e.g., 'INVOICE', 'QUOTE'). Used for filtering and determining how to display the attachment.

tags

string

Comma-separated list of tags associated with the attachment. Used for categorization and filtering of attachments.

lng

float

Longitude coordinate where the attachment was created. Used for geolocation of photos and other attachments. Decimal degrees format.

lat

float

Latitude coordinate where the attachment was created. Used for geolocation of photos and other attachments. Decimal degrees format.

photo_width

string

Width of the image in pixels. Only applicable for image attachments. Read-only in the API.

photo_height

string

Height of the image in pixels. Only applicable for image attachments. Read-only in the API.

extracted_info

string

Additional information extracted from the file, such as form responses or OCR text. Read-only in the API.

is_favourite

string

Flag indicating whether this attachment has been marked as a favorite. Used for filtering and displaying attachments.

class_name

string

The specific class type of the attachment. Used for specialized attachment types that extend the base dboAttachment class. Read-only in the API.

metadata

string

Additional structured data associated with the attachment in JSON format. The schema varies depending on attachment type and source. Used to store extended information that doesn't fit into standard fields.

uuid

Unique identifier for this record

created_by_staff_uuid

uuid

timestamp

string

Responses

200Success

400Bad Request - The request is malformed or contains invalid parameters

401Unauthorized - Authentication credentials are missing or invalid

403Forbidden - You don't have permission to create this resource

429Too Many Requests - You have exceeded the rate limit

500Internal Server Error - An unexpected error occurred on the server