# Update a document

**PUT /api/v1/document/{uuid}**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)


### Path parameters
- **uuid** (string)



### Body: application/json (object)

- **name** (string)
  The name of the document.
- **client_uuids** (array[string])
  An array containing the client uuids that should be sent the document when it is built.
- **known_dependants** (array[string])
  Optional: The document variable dependants. Used to swap variables out for real data.


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **version** (integer)
  The document builder version. Used for internal purposes only. Defaults to 3
- **name** (string)
  The name of the document.
- **status** (string)
  The status of the document.
- **last_publishing_error** (string)
  The last error that occurred during publishing.
- **required_dependants** (object)
  The required dependant variables of the document.
- **known_dependants** (object)
  The dependants submitted to the document previously.
- **public_docx_url** (string)
  The download URL of the DOCX content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.
- **public_sfdt_url** (string)
  The download URL of the SFDT (SyncFusion) content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.
- **public_pdf_url** (string)
  The download URL of the PDF content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.
- **public_preview_url** (string)
  The image preview URL of the document. This is intended for the user to preview the document before opening it. You can access this data via the API using the route in /api/v1.


[Powered by Bump.sh](https://bump.sh)