v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
invitations

Create an invitation to a collection

Creates an invitation to the matching collection.

post/collections/{collection_id}/invitations

Request body

Example request

{
  "data": {
    "attributes": {
      "email": "test@example.com",
      "permission_level": "guest",
      "personal_message": "Welcome to my Brandfolder!"
    }
  }
}

Response

The new invitation.

Example response

{
  "data": {
    "attributes": {
      "id": "a3dlao-hd6so4-7d91d2",
      "attributes": {
        "email": "test@example.com",
        "permission_level": "guest",
        "personal_message": "Welcome to my Brandfolder!",
        "invitation_url": "https://brandfolder.com/invitations/abc123"
      }
    }
  }
}