BYbynder
Share collection

Share collection

Share a specific collection by ID.

post/api/v4/collections/{id}/share

Request

  • Base URL
    https://{your-bynder-domain}
  • URL
    https://{your-bynder-domain}/api/v4/collections/{id}/share
  • Auth
    • OAuth 2
      Authorization code: https://{your-auth-url}
      Client credentials
      Token URL: https://{your-bynder-domain}/v6/authentication/oauth2/token scopes: SHARECOLLECTION, SHARING
    • or API key in header Authorization

Path parameters

idstring required
Example:00000000-0000-0000-0000000000000000

Request body application/x-www-form-urlencoded

recipientsstring
groupsstring
profilesstring
collectionOptions'readOnly' | 'view' | 'readAccess' | 'edit'
loginRequiredboolean
dateStartstring
dateEndstring
sendMailboolean
messagestring

Example request

{
  "recipients": "user1@bynder.com,user2@bynder.com",
  "groups": "00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000",
  "profiles": "00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000",
  "collectionOptions": "view",
  "loginRequired": true,
  "dateStart": "2014-08-12T08:07:24Z",
  "dateEnd": "2015-08-12T08:07:24Z",
  "sendMail": true,
  "message": "Your message goes here"
}

Response

Collection shared.

messagestring
statuscodeinteger

Example response

{
  "message": "accepted",
  "statuscode": 202
}

Changes

No recorded changes to this operation across all 1 revision of this API.