{
  "opencollection": "1.0.0",
  "info": {
    "name": "DocuSign Admin AccountBrands EnvelopeRecipientTabs API",
    "version": "v2.1"
  },
  "items": [
    {
      "info": {
        "name": "EnvelopeRecipientTabs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Docusign Gets the tabs information for a signer or sign-in-person recipient in an envelope.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/recipients/:recipientId/tabs",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "envelopeId",
                "value": "",
                "type": "path",
                "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
              },
              {
                "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": "include_anchor_tab_locations",
                "value": "",
                "type": "query",
                "description": "When set to **true**, all tabs with anchor tab properties are included in the response. "
              },
              {
                "name": "include_metadata",
                "value": "",
                "type": "query",
                "description": "Reserved for DocuSign.\n"
              }
            ]
          },
          "docs": "Retrieves information about the tabs associated with a recipient. You can make a single API call to get all the tab values and information from a given, completed envelope in addition to draft ones.  Tab values can be retrieved by using the [EnvelopeRecipients:list method](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/list/) with query parameter include_tabs set to \"true\"."
        },
        {
          "info": {
            "name": "Docusign Adds tabs for a recipient.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/recipients/:recipientId/tabs",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "envelopeId",
                "value": "",
                "type": "path",
                "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
              },
              {
                "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`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds one or more tabs for a recipient."
        },
        {
          "info": {
            "name": "Docusign Updates the tabs for a recipient.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/recipients/:recipientId/tabs",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "envelopeId",
                "value": "",
                "type": "path",
                "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
              },
              {
                "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`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates one or more tabs for a recipient in a draft envelope. \n**Note**: The Update method can be used if the envelope is not yet complete. To update an existing tab, the request body must include the `tabId`."
        },
        {
          "info": {
            "name": "Docusign Deletes the tabs associated with a recipient.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/recipients/:recipientId/tabs",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The external account number (int) or account id GUID."
              },
              {
                "name": "envelopeId",
                "value": "",
                "type": "path",
                "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec "
              },
              {
                "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`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deletes one or more tabs associated with a recipient in a draft envelope."
        }
      ]
    }
  ],
  "bundled": true
}