# Share meeting (/docs/api/meetings/share-meeting)

## OpenAPI

```json
{
  "info": {
    "description": "The Circleback public REST API provides programmatic access to your meetings, notes, action items, transcripts, and more. Authenticate every request by sending your API key as a bearer token.",
    "title": "Circleback Public API",
    "version": "1.0.0"
  },
  "openapi": "3.2.0",
  "servers": [
    {
      "url": "https://circleback.ai/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "bearerFormat": "cb_<secret>",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "tags": [
    {
      "description": "Access meetings along with their notes, transcripts, attendees, recordings, and search.",
      "name": "Meetings"
    }
  ],
  "paths": {
    "/meeting/{meetingId}/share": {
      "put": {
        "description": "Shares a meeting with people, teams, workspaces, or the link, or removes their access. Returns the updated meeting.",
        "parameters": [
          {
            "description": "The unique identifier of the meeting.",
            "in": "path",
            "name": "meetingId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "The people, teams, workspaces, or link to share with, up to 50. Targets that fail are listed in errors; the rest still apply.",
                "items": {
                  "anyOf": [
                    {
                      "additionalProperties": false,
                      "properties": {
                        "access": {
                          "anyOf": [
                            {
                              "description": "The access level to grant.",
                              "enum": [
                                "Editor",
                                "Viewer",
                                "LimitedViewer"
                              ],
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "The access level to grant. Set to null to remove access."
                        },
                        "email": {
                          "description": "The email address to share the meeting with.",
                          "format": "email",
                          "type": "string"
                        },
                        "sendEmail": {
                          "default": false,
                          "description": "Set to true to email the people the meeting is shared with.",
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "email",
                        "access"
                      ],
                      "title": "ShareWithEmail",
                      "type": "object"
                    },
                    {
                      "additionalProperties": false,
                      "properties": {
                        "profileId": {
                          "description": "The ID of the person to share the meeting with.",
                          "exclusiveMinimum": 0,
                          "type": "integer"
                        },
                        "access": {
                          "anyOf": [
                            {
                              "description": "The access level to grant.",
                              "enum": [
                                "Editor",
                                "Viewer",
                                "LimitedViewer"
                              ],
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "The access level to grant. Set to null to remove access."
                        },
                        "sendEmail": {
                          "default": false,
                          "description": "Set to true to email the people the meeting is shared with.",
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "profileId",
                        "access"
                      ],
                      "title": "ShareWithProfile",
                      "type": "object"
                    },
                    {
                      "additionalProperties": false,
                      "properties": {
                        "access": {
                          "anyOf": [
                            {
                              "description": "The access level to grant.",
                              "enum": [
                                "Editor",
                                "Viewer",
                                "LimitedViewer"
                              ],
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "The access level to grant. Set to null to remove access."
                        },
                        "sendEmail": {
                          "default": false,
                          "description": "Set to true to email the people the meeting is shared with.",
                          "type": "boolean"
                        },
                        "teamId": {
                          "description": "The unique identifier of the team to share the meeting with.",
                          "exclusiveMinimum": 0,
                          "type": "integer"
                        }
                      },
                      "required": [
                        "teamId"
                      ],
                      "title": "ShareWithTeam",
                      "type": "object"
                    },
                    {
                      "additionalProperties": false,
                      "properties": {
                        "access": {
                          "anyOf": [
                            {
                              "description": "The access level to grant.",
                              "enum": [
                                "Editor",
                                "Viewer",
                                "LimitedViewer"
                              ],
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "The access level to grant. Set to null to remove access."
                        },
                        "sendEmail": {
                          "default": false,
                          "description": "Set to true to email the people the meeting is shared with.",
                          "type": "boolean"
                        },
                        "workspaceId": {
                          "description": "The unique identifier of the workspace to share the meeting with.",
                          "exclusiveMinimum": 0,
                          "type": "integer"
                        }
                      },
                      "required": [
                        "workspaceId"
                      ],
                      "title": "ShareWithWorkspace",
                      "type": "object"
                    },
                    {
                      "additionalProperties": false,
                      "properties": {
                        "linkAccess": {
                          "anyOf": [
                            {
                              "enum": [
                                "Editor",
                                "Viewer",
                                "LimitedViewer"
                              ],
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "The access level for anyone with the meeting link. Set to null to turn off the link."
                        }
                      },
                      "required": [
                        "linkAccess"
                      ],
                      "title": "ShareLink",
                      "type": "object"
                    }
                  ],
                  "title": "ShareTarget"
                },
                "maxItems": 50,
                "minItems": 1,
                "type": "array"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "description": "Circleback meeting ID. Can be used to generate a link to the meeting (`https://circleback.ai/meetings/${id}`).",
                      "type": "string"
                    },
                    "name": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Meeting name."
                    },
                    "createdAt": {
                      "description": "Meeting creation date, formatted as an ISO 8601 timestamp.",
                      "format": "date-time",
                      "type": "string"
                    },
                    "updatedAt": {
                      "description": "When the meeting was last updated.",
                      "format": "date-time",
                      "type": "string"
                    },
                    "duration": {
                      "anyOf": [
                        {
                          "type": "number"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Meeting duration in seconds."
                    },
                    "url": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "URL of the virtual meeting (Zoom, Google Meet, or Microsoft Teams)."
                    },
                    "recordingUrl": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "URL of the meeting recording file. Only valid for 24 hours, and only available if saving meeting recordings is enabled in settings."
                    },
                    "tags": {
                      "description": "Tags added to the meeting.",
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "id": {
                            "description": "The unique identifier of the tag.",
                            "exclusiveMinimum": 0,
                            "type": "number"
                          },
                          "name": {
                            "description": "The display name of the tag.",
                            "type": "string"
                          },
                          "description": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "A description of the tag."
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "description"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "icalUid": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Unique identifier of the calendar event associated with the meeting."
                    },
                    "attendees": {
                      "description": "Meeting attendees.",
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "profileId": {
                            "description": "The unique identifier of the person's profile.",
                            "exclusiveMinimum": 0,
                            "type": "number"
                          },
                          "name": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Calendar event invitee name if associated with a calendar event, or the name of the meeting participant."
                          },
                          "title": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The person's job title."
                          },
                          "companyName": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "The name of the company the person belongs to."
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Calendar event invitee email if associated with a calendar event."
                          },
                          "isCalendarEventOrganizer": {
                            "description": "Whether the attendee organized the calendar event.",
                            "type": "boolean"
                          },
                          "isCalendarInvitee": {
                            "description": "Whether the attendee was invited on the calendar event.",
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "profileId",
                          "name",
                          "email",
                          "title",
                          "companyName",
                          "isCalendarInvitee",
                          "isCalendarEventOrganizer"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "notes": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Circleback meeting notes with Markdown formatting."
                    },
                    "privateNotes": {
                      "description": "The authenticated user's private notes for the meeting.",
                      "type": "string"
                    },
                    "actionItems": {
                      "description": "Action items created for the meeting.",
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "id": {
                            "description": "Circleback action item ID.",
                            "exclusiveMinimum": 0,
                            "type": "number"
                          },
                          "title": {
                            "description": "Action item title.",
                            "type": "string"
                          },
                          "description": {
                            "description": "Action item description.",
                            "type": "string"
                          },
                          "assignee": {
                            "description": "Action item assignee, or null if unassigned.",
                            "anyOf": [
                              {
                                "additionalProperties": false,
                                "properties": {
                                  "profileId": {
                                    "description": "The unique identifier of the person's profile.",
                                    "exclusiveMinimum": 0,
                                    "type": "number"
                                  },
                                  "name": {
                                    "anyOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The person's full name."
                                  },
                                  "title": {
                                    "anyOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The person's job title."
                                  },
                                  "companyName": {
                                    "anyOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The name of the company the person belongs to."
                                  },
                                  "email": {
                                    "anyOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ],
                                    "description": "The person's email address."
                                  }
                                },
                                "required": [
                                  "profileId",
                                  "name",
                                  "email",
                                  "title",
                                  "companyName"
                                ],
                                "type": "object"
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "example": {
                              "profileId": 1,
                              "name": "John Appleseed",
                              "title": "Head of Operations",
                              "companyName": "Initech",
                              "email": "john@initech.com"
                            }
                          },
                          "status": {
                            "description": "Action item status, one of 'PENDING' or 'DONE'.",
                            "enum": [
                              "PENDING",
                              "DONE"
                            ],
                            "type": "string"
                          }
                        },
                        "required": [
                          "id",
                          "title",
                          "description",
                          "status",
                          "assignee"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "insights": {
                      "additionalProperties": {
                        "items": {
                          "additionalProperties": false,
                          "properties": {
                            "speaker": {
                              "anyOf": [
                                {
                                  "type": "string"
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Speaker the insight is associated with, if any."
                            },
                            "timestamp": {
                              "anyOf": [
                                {
                                  "type": "number"
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "Timestamp in seconds the insight is associated with, if any."
                            },
                            "insight": {
                              "anyOf": [
                                {
                                  "type": "string"
                                },
                                {
                                  "additionalProperties": {
                                    "anyOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "type": "number"
                                      },
                                      {
                                        "type": "boolean"
                                      },
                                      {
                                        "type": "null"
                                      }
                                    ]
                                  },
                                  "propertyNames": {
                                    "type": "string"
                                  },
                                  "type": "object"
                                }
                              ],
                              "description": "The insight result. A string, or an object when the insight has custom fields."
                            }
                          },
                          "required": [
                            "speaker",
                            "timestamp",
                            "insight"
                          ],
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "description": "Insight results for the meeting, keyed by the name of the user-created insight.",
                      "propertyNames": {
                        "type": "string"
                      },
                      "type": "object"
                    },
                    "linkAccess": {
                      "anyOf": [
                        {
                          "enum": [
                            "Editor",
                            "Viewer",
                            "LimitedViewer"
                          ],
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "Who can access the meeting through its shareable link."
                    },
                    "calendarEvent": {
                      "anyOf": [
                        {
                          "additionalProperties": false,
                          "properties": {
                            "id": {
                              "description": "The unique identifier of the calendar event.",
                              "exclusiveMinimum": 0,
                              "type": "number"
                            },
                            "icalUid": {
                              "anyOf": [
                                {
                                  "type": "string"
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The iCalendar unique identifier of the event."
                            },
                            "description": {
                              "description": "The description of the calendar event.",
                              "type": "string"
                            },
                            "platform": {
                              "anyOf": [
                                {
                                  "enum": [
                                    "GoogleCalendar",
                                    "MicrosoftOutlook"
                                  ],
                                  "type": "string"
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The calendar platform the event comes from."
                            },
                            "platformId": {
                              "anyOf": [
                                {
                                  "type": "string"
                                },
                                {
                                  "type": "null"
                                }
                              ],
                              "description": "The unique identifier of the event on the calendar platform."
                            }
                          },
                          "required": [
                            "id",
                            "platform",
                            "platformId",
                            "description",
                            "icalUid"
                          ],
                          "type": "object"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "errors": {
                      "description": "Targets that could not be shared. Omitted when all succeed.",
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "error": {
                            "description": "Why the target could not be shared.",
                            "type": "string"
                          },
                          "index": {
                            "description": "The position of the target in the request.",
                            "type": "number"
                          }
                        },
                        "required": [
                          "index",
                          "error"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "sharedWith": {
                      "description": "People, teams, and workspaces with access to the meeting.",
                      "items": {
                        "anyOf": [
                          {
                            "additionalProperties": false,
                            "properties": {
                              "profileId": {
                                "description": "The unique identifier of the person's profile.",
                                "exclusiveMinimum": 0,
                                "type": "number"
                              },
                              "name": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "type": "null"
                                  }
                                ],
                                "description": "The person's full name."
                              },
                              "access": {
                                "description": "The access level granted.",
                                "enum": [
                                  "Owner",
                                  "Editor",
                                  "Viewer",
                                  "LimitedViewer"
                                ],
                                "type": "string"
                              },
                              "email": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "type": "null"
                                  }
                                ],
                                "description": "The person's email address."
                              }
                            },
                            "required": [
                              "profileId",
                              "name",
                              "email",
                              "access"
                            ],
                            "title": "SharedWithPerson",
                            "type": "object"
                          },
                          {
                            "additionalProperties": false,
                            "properties": {
                              "name": {
                                "description": "The team's name.",
                                "type": "string"
                              },
                              "access": {
                                "description": "The access level granted.",
                                "enum": [
                                  "Owner",
                                  "Editor",
                                  "Viewer",
                                  "LimitedViewer"
                                ],
                                "type": "string"
                              },
                              "teamId": {
                                "description": "The unique identifier of the team.",
                                "exclusiveMinimum": 0,
                                "type": "number"
                              }
                            },
                            "required": [
                              "teamId",
                              "name",
                              "access"
                            ],
                            "title": "SharedWithTeam",
                            "type": "object"
                          },
                          {
                            "additionalProperties": false,
                            "properties": {
                              "name": {
                                "description": "The workspace's name.",
                                "type": "string"
                              },
                              "access": {
                                "description": "The access level granted.",
                                "enum": [
                                  "Owner",
                                  "Editor",
                                  "Viewer",
                                  "LimitedViewer"
                                ],
                                "type": "string"
                              },
                              "workspaceId": {
                                "description": "The unique identifier of the workspace.",
                                "exclusiveMinimum": 0,
                                "type": "number"
                              }
                            },
                            "required": [
                              "workspaceId",
                              "name",
                              "access"
                            ],
                            "title": "SharedWithWorkspace",
                            "type": "object"
                          }
                        ]
                      },
                      "type": "array"
                    }
                  },
                  "required": [
                    "id",
                    "linkAccess",
                    "url",
                    "createdAt",
                    "updatedAt",
                    "duration",
                    "name",
                    "notes",
                    "icalUid",
                    "recordingUrl",
                    "tags",
                    "attendees",
                    "actionItems",
                    "insights",
                    "calendarEvent",
                    "privateNotes",
                    "sharedWith"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "Successful response."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "code": {
                      "description": "A machine-readable code identifying the type of failure.",
                      "type": "string"
                    },
                    "error": {
                      "description": "A human-readable message explaining why the request failed.",
                      "type": "string"
                    },
                    "seatsToAdd": {
                      "description": "The authoritative number of workspace seats required.",
                      "exclusiveMinimum": 0,
                      "type": "integer"
                    },
                    "issues": {
                      "description": "The field-level validation issues found in an invalid request.",
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "message": {
                            "description": "A human-readable explanation of the validation failure.",
                            "type": "string"
                          },
                          "path": {
                            "description": "The location of the request field that failed validation.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "path",
                          "message"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    }
                  },
                  "required": [
                    "error"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "The request failed validation."
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1meeting~1{meetingId}~1share/put/responses/400/content/application~1json/schema"
                }
              }
            },
            "description": "The request exceeded the rate limit for the account's plan, which the error message names: 3 requests per second and 20 per minute on Free, 20 per second and 300 per minute on Pro, Business, and Enterprise. Retry after the number of seconds in the `Retry-After` header."
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "summary": "Share meeting",
        "tags": [
          "Meetings"
        ]
      }
    }
  }
}
```