Issue with Applying Form Fields via PUT API in Authoring State (REST API v6)
Hello,
I'm encountering an issue when creating form fields using the PUT /agreements/{agreementId}/formFields endpoint in REST API v6. This occurs specifically when the agreement is created in the Authoring state and I immediately try to apply form fields.
Error response:
{
"code" : "DOCUMENT_NOT_AVAILABLE",
"message" : "The document is not yet available or will have no pages to view"
}
To work around this, I currently implement a retry mechanism that attempts the PUT request up to 10 times with a 2-second delay between tries. If it fails after 10 attempts, the process is aborted.
What I've tried:
1. Creating the agreement in Draft state
This doesn't work for my use case, as I can't retrieve the participantSetId needed for assigning fields—these IDs appear to be available only after switching to Authoring state. I'm also unsure if there's a way to assign fields without having those IDs.
I have also found this: https://helpx.adobe.com/sign/kb/formfields-option-is-not-available-in-v6-of-rest-api-adobe-sign.html
There the form field was assigned using a property called recipientIndex but I can't find this in the official API reference.
2. Using REST API v5
I noticed v5 allowed form fields to be added during agreement creation, but this functionality has been removed in v6.
My questions:
- Is there a more reliable or recommended way to handle this timing issue?
- Is it possible to assign form fields without knowing the participantSetId?
- Are there best practices for waiting until the document is "available" for form field updates?
Any guidance would be greatly appreciated.
Thanks
