The schema for the envelope creation endpoint allows the addition of an envelope attachment. However, adding one at envelope creation time does not work. The envelope is created, but the attachment is not (as confirmed by querying the API for envelope attachments with the envelope ID).
If I first create the envelope, then add the attachment with the exact same attachment properties, the attachment gets created as expected. Is this a bug? If not, why put envelope attachments in the envelope creation request schema?
Also, some of the fields are very confusing in their behavior and in their descriptions in the documentation. I’m hoping someone may have some insight to a few of them.
AttachmentId - If an attachmentId is provided to create the attachment via the envelope attachments create endpoint, a different, unique ID is returned when querying for it. Why give the ability to provide an ID if it changes regardless of what’s provided?
Label - What does this field actually do? The documentation mentions that potential values include ‘eventNotifications’ which is a list of event statuses. The field is a string, how can this be a list of values? Does giving the label some magic string value cause any downstream behavior? If this is just a label then the examples in the docs seem to just muddy the water.
AttachmentType - Nowhere in the documentation am I able to find what this is referring to. It seems to accept any value without validation. Is this just a reference for consumers of the attachment to know how to decode the base64 encoded document string in the data field?
Access Control - Just some feedback that it would be nice to call out that the default value appears to be ‘Sender’ unless you specify otherwise.
Lastly, I want to consume the attachment via a connect event. I’ve updated the connect configuration to include attachments, but the attachment data isn’t returned in the event - only the ID of the attachment. Is this intended behavior? I was expected to get the data string back, similar to how the document data is returned in the response.
Thank you for your feedback.
Our API reference has information on our fileds and attributes.
See section Schema
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/
Regards
Adrian
Dev Support
Hello
Answer does not come from me, but if you could check this :
It sounds like you're experiencing some challenges with the envelope creation endpoint and its associated schema in DocuSign. Let me address each of your questions and concerns in detail:
### 1. Envelope Attachment at Creation Time
**Issue:**
Adding an attachment during envelope creation does not work as expected.
**Explanation:**
This might not be a bug but a limitation or expected behavior in the current API implementation. The documentation may mention the possibility of adding attachments at the envelope creation stage, but the actual functionality could be constrained by the system's processing order.
**Workaround:**
The recommended approach, as you've found, is to first create the envelope and then add the attachment using the `envelope attachments create` endpoint.
### 2. AttachmentId Behavior
**Issue:**
The `AttachmentId` provided at creation changes when queried.
**Explanation:**
The `AttachmentId` you provide is likely intended as a client-side reference, whereas the system generates its own unique identifier for the attachment for internal tracking. This is common in many APIs to ensure the uniqueness and integrity of resource identifiers.
**Clarification:**
While the documentation should clarify this, it's not uncommon for APIs to accept a client-provided ID for reference but ultimately replace it with a system-generated one.
More info :
AttachmentId:
- When creating an attachment, the provided
AttachmentId
is not retained. Instead, a uniqueAttachmentId
is generated by the system to ensure uniqueness and avoid conflicts. This behavior ensures that each attachment can be uniquely identified even if multiple attachments are created with similar input properties
### 3. Label Field
**Issue:**
The behavior and purpose of the `Label` field are unclear.
**Explanation:**
The `Label` field is intended to categorize or tag the attachment. The mention of `eventNotifications` seems to be a documentation error or miscommunication. Typically, a label is a simple string used for categorization and does not directly influence downstream behavior.
**Suggestion:**
Use the `Label` field for your internal categorization needs. If the field accepts any string, it can help you organize attachments but does not trigger any specific system actions.
### 4. AttachmentType Field
**Issue:**
The `AttachmentType` field lacks clear documentation.
**Explanation:**
The `AttachmentType` field is likely intended for clients to specify the type of attachment for their reference. Since it accepts any value without validation, it suggests that this field is used more for informational purposes rather than driving any backend logic.
**Clarification:**
This field allows consumers of the API to identify or classify attachments based on their own criteria. It helps in understanding how to process or decode the attachment content.
### 5. Access Control Default Value
**Feedback:**
The default value for access control is `Sender`.
**Suggestion:**
It's good to have this feedback documented. Knowing the default values helps in planning and setting appropriate values explicitly if needed.
### 6. Attachment Data in Connect Event
**Issue:**
Attachment data is not returned in the connect event.
**Explanation:**
This is likely intended behavior. Due to potential size and performance implications, only the `AttachmentId` is included in the connect event. The actual data may need to be retrieved separately using the `AttachmentId`.
**Solution:**
After receiving the connect event, you can make an API call to retrieve the attachment data using the `AttachmentId` provided in the event.
**Example:**
Python
attachment_data = docusign_client.get_attachment(envelope_id, attachment_id)
```
### Summary
- **Envelope Creation:** Add attachments after creating the envelope.
- **AttachmentId:** System-generated IDs ensure uniqueness.
- **Label:** Use for internal categorization.
- **AttachmentType:** Informational field for client-side use.
- **Access Control:** Default is `Sender`, specify otherwise if needed.
- **Connect Event:** Retrieve attachment data separately using the provided `AttachmentId`.
These clarifications should help you navigate the API more effectively. If you have further questions, consulting the latest API documentation or reaching out to DocuSign support may provide additional insights.
Don’t hesite to open a support ticket
Have a great day
Reply
Sign up
Already have an account? Login
You can login or register as either a Docusign customer or developer. If you don’t already have a Docusign customer or developer account, you can create one for free when registering.
Customer Login/Registration Developer Login/RegistrationDocusign Community
You can login or register as either a Docusign customer or developer. If you don’t already have a Docusign customer or developer account, you can create one for free when registering.
Customer Login/Registration Developer Login/RegistrationEnter your E-mail address. We'll send you an e-mail with instructions to reset your password.