Attachments

Create a new Attachment

Changed on

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.

post/attachment.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/attachment.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: manage_attachments

Request body

related_objectstring

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_uuidstring 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_namestring

The security roles description

file_typestring

Location's name

attachment_sourcestring

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

tagsstring

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

lngnumber float

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

latnumber float

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

photo_widthstring

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

photo_heightstring

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

extracted_infostring

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

is_favouritestring

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

class_nameunknown
metadatastring

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.

uuidstring uuid

Unique identifier for this record

created_by_staff_uuidstring uuid
timestampstring

Example request

{
  "related_object_uuid": "123e4567-e2d6-438c-b5fd-23f94d0b0a5b",
  "uuid": "123e4567-0a17-4196-9697-23f94950984b",
  "created_by_staff_uuid": "123e4567-0a69-4b5b-9b47-23f94973bddb"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes