{ "opencollection": "1.0.0", "info": { "name": "DocuSign Admin AccountBrands TemplateBulkRecipients API", "version": "v2.1" }, "items": [ { "info": { "name": "TemplateBulkRecipients", "type": "folder" }, "items": [ { "info": { "name": "Docusign Gets the bulk recipient file from a template.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/templates/:templateId/recipients/:recipientId/bulk_recipients", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "recipientId", "value": "", "type": "path", "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`." }, { "name": "templateId", "value": "", "type": "path", "description": "The ID of the template being accessed." }, { "name": "include_tabs", "value": "", "type": "query", "description": "When set to **true**, the tab information associated with the recipient is included in the response." }, { "name": "start_position", "value": "", "type": "query", "description": "Reserved for DocuSign.\n" } ] }, "docs": "Retrieves the bulk recipient file information from a template that has a bulk recipient." }, { "info": { "name": "Docusign Adds or replaces the bulk recipients list in a template.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/templates/:templateId/recipients/:recipientId/bulk_recipients", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "recipientId", "value": "", "type": "path", "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`." }, { "name": "templateId", "value": "", "type": "path", "description": "The ID of the template being accessed." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).\n\nThe REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file." }, { "info": { "name": "Docusign Deletes the bulk recipient list on a template.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/templates/:templateId/recipients/:recipientId/bulk_recipients", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "recipientId", "value": "", "type": "path", "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`." }, { "name": "templateId", "value": "", "type": "path", "description": "The ID of the template being accessed." } ] }, "docs": "Deletes the bulk recipient list on a template." } ] } ], "bundled": true }