{ "opencollection": "1.0.0", "info": { "name": "DocuSign Admin AccountBrands API", "version": "v2.1" }, "items": [ { "info": { "name": "AccountBrands", "type": "folder" }, "items": [ { "info": { "name": "Docusign Gets a list of brand profiles.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "exclude_distributor_brand", "value": "", "type": "query", "description": "When set to **true**, excludes distributor brand information from the response set." }, { "name": "include_logos", "value": "", "type": "query", "description": "When set to **true**, returns the logos associated with the brand." } ] }, "docs": "Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call." }, { "info": { "name": "Docusign Creates one or more brand profile files for the account.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call.\n\nAn error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version.\n\nWhen brand profile files are being uploaded, they must be combined into " }, { "info": { "name": "Docusign Deletes one or more brand profiles.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** to use this call." }, { "info": { "name": "Docusign Get information for a specific brand.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." }, { "name": "include_external_references", "value": "", "type": "query" }, { "name": "include_logos", "value": "", "type": "query" } ] }, "docs": "Docusign Get information for a specific brand." }, { "info": { "name": "Docusign Updates an existing brand.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Docusign Updates an existing brand." }, { "info": { "name": "Docusign Removes a brand.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." } ] }, "docs": "Docusign Removes a brand." }, { "info": { "name": "Docusign Export a specific brand.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId/file", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." } ] }, "docs": "Docusign Export a specific brand." }, { "info": { "name": "Docusign Obtains the specified image for a brand.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId/logos/:logoType", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." }, { "name": "logoType", "value": "", "type": "path", "description": "One of **Primary**, **Secondary** or **Email**." } ] }, "docs": "Docusign Obtains the specified image for a brand." }, { "info": { "name": "Docusign Put one branding logo.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId/logos/:logoType", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." }, { "name": "logoType", "value": "", "type": "path", "description": "One of **Primary**, **Secondary** or **Email**." } ] }, "docs": "Docusign Put one branding logo." }, { "info": { "name": "Docusign Delete one branding logo.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId/logos/:logoType", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." }, { "name": "logoType", "value": "", "type": "path", "description": "One of **Primary**, **Secondary** or **Email**." } ] }, "docs": "Docusign Delete one branding logo." }, { "info": { "name": "Docusign Returns the specified account's list of branding resources (metadata).", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId/resources", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." } ] }, "docs": "Docusign Returns the specified account's list of branding resources (metadata)." }, { "info": { "name": "Docusign Returns the specified branding resource file.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId/resources/:resourceContentType", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." }, { "name": "resourceContentType", "value": "", "type": "path" }, { "name": "langcode", "value": "", "type": "query" }, { "name": "return_master", "value": "", "type": "query" } ] }, "docs": "Docusign Returns the specified branding resource file." }, { "info": { "name": "Docusign Uploads a branding resource file.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/brands/:brandId/resources/:resourceContentType", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "brandId", "value": "", "type": "path", "description": "The unique identifier of a brand." }, { "name": "resourceContentType", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file.xml", "type": "text", "value": "" } ] } }, "docs": "Docusign Uploads a branding resource file." } ] } ], "bundled": true }