Parameter

Example

API version

recipient_id

Recipient identifier

integer

36456

stage_id

Stage identifier

integer

6778

name

The name of the recipient

string

John Doe

email

The recipient email address

string

john.doe@proofhq.com

position

The recipient position

string

Manager

role

The role of the recipient on the proof:

1 - read only

3 - reviewer

4 - approver

5 - reviewer & approver

6 - author

7 - moderator

integer

1

email_notification

The email notification setting for the recipient on this proof:

1 - all activity

2 - replies to my comments

5 - decisions

6 - final decision

4 - hourly summary

3 - daily summary

9 - disabled

integer

1

primary_decision_maker

Determines if this recipient is the primary decision maker

boolean

true

decision

The recipients decision, if available. Possible values:

pending
changes required
changes requested
not approved
approved with changes
approved
not relevant
- (for non decision makers)

string

pending

14.25

proof_url

The personal proofing url of the recipient

string

http://app.proofhq.com/proof/XXXXXXX

15.22

wf_decision

Workfront decision made on the document by the recipient

integer

18.2