---
title: "Share collection"
url: "https://earlyaccess.developers.bynder.com/apis/collections-api-1/versions/fa75179f-d3db-46c2-8693-3128e9d35db4/paths/api-v4-collections-id--share/post"
---

> Full API specification: https://earlyaccess.developers.bynder.com/apis/collections-api-1/versions/fa75179f-d3db-46c2-8693-3128e9d35db4.md

# Share collection

`POST` `/api/v4/collections/{id}/share`

Share a specific collection by ID.

## Path parameters

- `id` (string, required)

## Request body (required)

Content types: `application/x-www-form-urlencoded`

## Responses

- `202` - Collection shared.
- `400` - Invalid request parameters.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Collections API
  version: 1.0.0
servers:
  - url: https://{your-bynder-domain}/
paths:
  /api/v4/collections/{id}/share:
    post:
      description: Share a specific collection by ID.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            example: 00000000-0000-0000-0000000000000000
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                collectionOptions:
                  enum:
                    - readOnly
                    - view
                    - readAccess
                    - edit
                  example: view
                  type: string
                dateEnd:
                  example: 2015-08-12T08:07:24Z
                  type: string
                dateStart:
                  example: 2014-08-12T08:07:24Z
                  type: string
                groups:
                  example: 00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000
                  type: string
                loginRequired:
                  example: true
                  type: boolean
                message:
                  example: Your message goes here
                  type: string
                profiles:
                  example: 00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000
                  type: string
                recipients:
                  example: user1@bynder.com,user2@bynder.com
                  type: string
                sendMail:
                  example: true
                  type: boolean
              type: object
        required: true
      responses:
        "202":
          content:
            application/json:
              schema:
                properties:
                  message:
                    example: accepted
                    type: string
                  statuscode:
                    example: 202
                    type: integer
                type: object
          description: Collection shared.
        "400":
          content:
            application/json:
              schema:
                properties:
                  message:
                    example: Recipients, groups or profiles must contain at least one entry
                    type: string
                  statuscode:
                    example: 400
                    type: integer
                type: object
          description: Invalid request parameters.
      security:
        - OAuth2:
            - SHARECOLLECTION
            - SHARING
        - permanentToken:
            - SHARECOLLETION
            - SHARING
      summary: Share collection
      tags:
        - Share collection
security:
  - OAuth2:
      - SHARECOLLECTION
      - SHARING
  - permanentToken:
      - SHARECOLLETION
      - SHARING
components:
  securitySchemes:
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://{your-auth-url}
          scopes:
            COLLECTIONS: ""
            INBOXPUBLIC: To retrieve collections other users shared/received
            OUTBOXPUBLIC: To retrieve collections other users shared/received
            PUBLICCOLLECTIONS: To retrieve collections other users created
            PUBLISHCOLLECTIONS: ""
            SHARECOLLECTION: ""
            SHARING: ""
            collection.public.view: To retrieve public collections
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
        clientCredentials:
          scopes:
            COLLECTIONS: ""
            INBOXPUBLIC: To retrieve collections other users shared/received
            OUTBOXPUBLIC: To retrieve collections other users shared/received
            PUBLICCOLLECTIONS: To retrieve collections other users created
            PUBLISHCOLLECTIONS: ""
            SHARECOLLECTION: ""
            SHARING: ""
            collection.public.view: To retrieve public collections
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
      type: oauth2
    permanentToken:
      in: header
      name: Authorization
      type: apiKey
```