Skip to content
Docs
Select language:English

/api/v1/attachments/{id} (PATCH)

PATCH
/api/v1/attachments/{id}
curl --request PATCH \
  --url https://example.com/api/v1/attachments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "role": "photo", "sort": 1 }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
role
string
Allowed values: photo receipt invoice manual warranty_doc proof condition_out condition_in registration document
sort
integer
>= -1000000 <= 1000000

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
role
required
string
Allowed values: photo receipt invoice manual warranty_doc proof condition_out condition_in registration document
sort
required
number
file
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
sha256
required
string
bytes
required
number
mime
required
string
class
required
string
Allowed values: evidence photo document video
hasGps
required
boolean
width
required
number | null
height
required
number | null
derivativeState
required
string
Allowed values: ready pending unavailable not_applicable
thumbUrl
required
string | null
displayUrl
required
string | null
deduplicatedFrom
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
url
required
string | null
subject
required
Any of:
object
thingId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
createdBy
required
object
displayName
required
string
rowVersion
required
number
Example
{
  "role": "photo",
  "file": {
    "class": "evidence",
    "derivativeState": "ready"
  },
  "subject": {
    "location": true
  }
}