Patch document

patch

https://{host}/rest/v1/{agencyId}/documents

Patches document and returns saved document ID and registration number

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

agencyId

string

required

Query Params

int64

ID of document

number

string

Registration number of document

Body Params

int64

version

int64

isDisabled

boolean

isDraft

boolean

authorId

int64

type

string

Type of Document created (Type MUST match Teamogy configuration)

agencyId

int64

ID of the Business Unit to which the Document belongs (optional, if not defined, agencyId from URL will be used)

ownerId

int64

ID of the User who is the Owner of the Document

ownerName

string

Name of the User who is the Owner of the Document

companyId

int64

ID of the Company that is the counterparty to the Document

companyName

string

Name of the Company that is the counterparty to the Document

personId

int64

ID of the Person in the Company who is the counterparty to the Document (optional)

binderId

int64

ID of the Binder in which the Document will be included (optional)

category

string

Document Category (optional, Category MUST match Teamogy configuration)

process

object

properties

object

Another Document properties (optional fields, field names and value types MUST match Teamogy configuration)

readOnly

boolean

acl

object

Document Access Controll List (optional, manually added above the Default Access Controll List). Final ACL is the merge of Manually attached and Default Access rights

attach

array of strings

Array of attachment links

attach

Headers

host

string

required

Specific domain your company have registered. For example 'yourcompany.teamogy.com'

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK