shares

Share Page

Share a page with another user. Supports different scopes:

  • single: Just this page
  • with_children: This page and all sub-pages
  • folder: Share the entire folder (if page belongs to one)
post/api/shares/pages/{page_id}

Request

  • Base URL: https://app.ctlsurf.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.ctlsurf.com/api/shares/pages/{page_id}
  • Auth: HTTP bearer

Path parameters

page_idstring uuid required

Request body

emailstring email required
permission'view' | 'edit' | 'admin'

Permission levels for shared resources.

scope'single' | 'with_children' | 'folder'

Scope of sharing for pages.

Response

Successful Response

idstring uuid required
page_idstring uuid required
permission'view' | 'edit' | 'admin' required

Permission levels for shared resources.

created_bystring uuid required
created_atstring date-time required

Changes

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