Skip to main content
POST
/
file-shares
Create File Share
curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/file-shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": [
    "fsd_abc123456789",
    "fsf_abc123456789"
  ],
  "customerId": "cst_abc123456789"
}
'
{
  "id": "fss_abc12345678",
  "sharedWithCustomerId": "cst_abc12345678",
  "sharedContent": "<array>",
  "createdAt": "2024-04-29T21:00:00+02:00",
  "links": {
    "customer": {
      "href": "https://api.mijnklantportaal.nl/v1/customers/cst_abc12345def678",
      "type": "<string>"
    },
    "publicShare": {
      "href": "<string>",
      "type": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
content
string[]
required

An array of Directory and/or File IDs which you want to share

Example:
["fsd_abc123456789", "fsf_abc123456789"]
​
customerId
string

The ID of the Customer you want to share the content with. Omit if you want to use a public link

Example:

"cst_abc123456789"

Response

Returning the created File Share

File Share

​
id
string

ID of the File Share, always starting with fss_.

Example:

"fss_abc12345678"

​
sharedWithCustomerId
string | null

ID of the customer this File Share is shared with, if any.

Example:

"cst_abc12345678"

​
sharedContent
array

An array with File and Directory objects which are shared via this File Share.

​
createdAt
string

Date and time when the File Share was created. Written in ATOM format.

Example:

"2024-04-29T21:00:00+02:00"

​
links
object