{
  "opencollection": "1.0.0",
  "info": {
    "name": "DocuSign Admin AccountBrands TemplateRecipients API",
    "version": "v2.1"
  },
  "items": [
    {
      "info": {
        "name": "TemplateRecipients",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Docusign Gets recipient information from a template.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/templates/:templateId/recipients",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "templateId",
                "value": "",
                "type": "path",
                "description": "The ID of the template being accessed."
              },
              {
                "name": "include_anchor_tab_locations",
                "value": "",
                "type": "query",
                "description": " When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. "
              },
              {
                "name": "include_extended",
                "value": "",
                "type": "query",
                "description": " When set to **true**, the extended properties are included in the response. "
              },
              {
                "name": "include_tabs",
                "value": "",
                "type": "query",
                "description": "When set to **true**, the tab information associated with the recipient is included in the response."
              }
            ]
          },
          "docs": "Retrieves the information for all recipients in the specified template."
        },
        {
          "info": {
            "name": "Docusign Adds tabs for a recipient.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/templates/:templateId/recipients",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "templateId",
                "value": "",
                "type": "path",
                "description": "The ID of the template being accessed."
              },
              {
                "name": "resend_envelope",
                "value": "",
                "type": "query",
                "description": "When set to **true**, resends the   envelope if the new recipient's routing order is before or the same as the envelope's next recipient."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds one or more recipients to a template."
        },
        {
          "info": {
            "name": "Docusign Updates recipients in a template.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/templates/:templateId/recipients",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "templateId",
                "value": "",
                "type": "path",
                "description": "The ID of the template being accessed."
              },
              {
                "name": "resend_envelope",
                "value": "",
                "type": "query",
                "description": "When set to **true**, resends the   envelope if the new recipient's routing order is before or the same as the envelope's next recipient."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates recipients in a template. \n\nYou can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`."
        },
        {
          "info": {
            "name": "Docusign Deletes recipients from a template.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/templates/:templateId/recipients",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "templateId",
                "value": "",
                "type": "path",
                "description": "The ID of the template being accessed."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients."
        },
        {
          "info": {
            "name": "Docusign Deletes the specified recipient file from a template.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/templates/:templateId/recipients/:recipientId",
            "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": "Deletes the specified recipient file from the specified template."
        }
      ]
    }
  ],
  "bundled": true
}