Add Company Attachment

POST

https://api-b2b.bigcommerce.com/api/v3/io/companies/:companyId/attachments

Attaches a file to a Company account. The default rate limit for this endpoint is `15` calls/min per store. Each Company can have a maximum of `10` attachments. The following file types are supported: ``` - Image files (BMP, GIF, ICO, JPG/JPEG, PNG, SVG, TIF, TIFF, WEBP, WBMP, XBM) - PDF - DOC, DOCX - XLS, XLSX - CSV ```

Add Company Attachment

POST

https://api-b2b.bigcommerce.com/api/v3/io/companies/:companyId/attachments

Attaches a file to a Company account.

The default rate limit for this endpoint is 15 calls/min per store.

Each Company can have a maximum of 10 attachments. The following file types are supported:

- Image files (BMP, GIF, ICO, JPG/JPEG, PNG, SVG, TIF, TIFF, WEBP, WBMP, XBM)
- PDF
- DOC, DOCX
- XLS, XLSX
- CSV

Authentication

X-Auth-Tokenstring

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

companyIdintegerRequired

Unique numeric ID of the Company account.

Request

attachmentFilefileRequired

Attaches a file to the Company account. The file must be a supported type and not exceed 10MB.

Response

codedoubleDefaults to 200

dataobject

metaobject

$	curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/companies/123456/attachments \
>	-H "X-Auth-Token: <apiKey>" \
>	-H "Content-Type: multipart/form-data" \
>	-F attachmentFile=@string

1	{
2	"code": 200,
3	"data": {
4	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
5	"attachmentFile": "https://example.com/example.csv"
6	},
7	"meta": {
8	"message": "SUCCESS"
9	}
10	}

$	curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/companies/123456/attachments \
>	-H "X-Auth-Token: <apiKey>" \
>	-H "Content-Type: multipart/form-data" \
>	-F attachmentFile=@string

1	{
2	"code": 200,
3	"data": {
4	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
5	"attachmentFile": "https://example.com/example.csv"
6	},
7	"meta": {
8	"message": "SUCCESS"
9	}
10	}