Documents

Update a profile document

PUT update document

Endpoint

PUT /api/v1/users/profile/documents/:id

Parameters

Name Description
document[name] required Document name
document[file] Document file

Request

Route

PUT /api/v1/users/profile/documents/3

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxODIxIiwic2NwIjoidXNlciIsImF1ZCI6bnVsbCwiaWF0IjoxNzM3NTUxNTkzLCJleHAiOjE3NDAxNDM1OTMsImp0aSI6Ijg2ODQ1ZTk1LWFmYzEtNGU0OC04YjdmLTg0MzVjMDJiMmFjNyJ9.1UBarG2QYHVSGcWtlZY7XI4Hs1WQPZGoG-Iu9NJzQjY
Host: example.org
Cookie:

Body

{
  "document": {
    "name": "sapiente"
  }
}

Response

Simulated Response

Status

200

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"b045f9ed0c94226a08c574da2b7cadaa"
cache-control: max-age=0, private, must-revalidate
x-request-id: fa568698-3c83-42e1-95d7-685699d5b0d6
x-runtime: 0.017684
content-length: 385

Body

{
  "document": {
    "id": 3,
    "file": {
      "id": 28,
      "signed_id": "eyJfcmFpbHMiOnsiZGF0YSI6MzAsInB1ciI6ImJsb2JfaWQifX0=--0595eb756770f9c469b6ae41c60f357890973e9f",
      "byte_size": 596,
      "filename": "test_image.png",
      "url": "http://localhost:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MzAsInB1ciI6ImJsb2JfaWQifX0=--0595eb756770f9c469b6ae41c60f357890973e9f/test_image.png"
    },
    "name": "sapiente"
  }
}