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.eyJzdWIiOiIxOTA5Iiwic2NwIjoidXNlciIsImF1ZCI6bnVsbCwiaWF0IjoxNzYzNjI2NDE0LCJleHAiOjE3NjYyMTg0MTQsImp0aSI6ImIxNzFkNjUwLTA4NjctNGNjNS1hZGNlLTIwZjZhM2E2YTE5OSJ9.K4tuEtNQat2mBHKrm6BhRSijrDF228XZ5euKlBGDIRI
Host: example.org
Cookie:

Body

{
  "document": {
    "name": "dolore"
  }
}

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/"3153d364f79ac4994c57856c272a693d"
cache-control: max-age=0, private, must-revalidate
x-request-id: 0f0214bf-147a-4e8e-ba83-dd856e67acc8
x-runtime: 0.012915
content-length: 383

Body

{
  "document": {
    "id": 3,
    "file": {
      "id": 29,
      "signed_id": "eyJfcmFpbHMiOnsiZGF0YSI6MzMsInB1ciI6ImJsb2JfaWQifX0=--f154bccd5a284814aae03c22ed695c69602b6ab6",
      "byte_size": 596,
      "filename": "test_image.png",
      "url": "http://localhost:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MzMsInB1ciI6ImJsb2JfaWQifX0=--f154bccd5a284814aae03c22ed695c69602b6ab6/test_image.png"
    },
    "name": "dolore"
  }
}