AIair
Share Links

/boards/:boardId/share-links

Changed on

Create the share link for a board.

Any field not listed in the request body is ignored. Send an empty object to create a link with the default settings. A new link is active unless you send active: false.

password, expiresAt, requireAccount, comments and customFields depend on your workspace's plan; see the request body for what returns 422.

Settings you leave out follow your workspace's share link defaults. If your workspace hasn't saved share link defaults and a board above this one already has a share link, the new link takes what visitors can do and the password from the share link of the highest such board. A password you send replaces the one it would take, and password: null creates the link with no password. Check hasPassword in the response.

Returns 403 if the link's settings, including the ones it takes from your workspace defaults or a board above, would let visitors do something you can't do yourself.

A board has at most one share link. Returns 409 Conflict if it already has one, even a disabled one. Use GET /v1/boards/{boardId}/share-links to find it, and PATCH to change it.

Requires the share_links.write and boards.read OAuth scopes.

post/v1/boards/{boardId}/share-links

Request

Request body

activeboolean

Whether the link works. A disabled link keeps its settings and can be enabled again.

allowDownloadboolean

Whether visitors can download the original files

passwordstring nullable

Password visitors must enter to open the link. null removes it. Never returned; read hasPassword instead.

expiresAtstring date-time nullable

When the link stops working. Must be in the future. null removes the expiration.

requireAccountboolean

Whether visitors must sign in to Air to open the link

comments'hidden' | 'read_only' | 'allowed'

What visitors can do with comments. allowed lets them add comments, which writes to your workspace.

customFields'hidden' | 'read_only' | 'editable'

What visitors can do with custom field values. editable lets them change values, which writes to your workspace.

Response

Share link created successfully

idstring required

The share link ID. It is also the last part of url.

urlstring uri required

The public share link to give to people. It is not an Air app link and not a CDN link.

activeboolean required

Whether the link is enabled. Disabled links are still listed.

hasPasswordboolean required

Whether visitors must enter a password to open the link. The password itself is never returned.

expiresAtstring date-time nullable required

When the link stops working, or null if it never expires

requireAccountboolean required

Whether visitors must sign in to Air to open the link

allowDownloadboolean required

Whether visitors can download the original files

comments'hidden' | 'read_only' | 'allowed' required

What visitors can do with comments. hidden: they can't see comments. read_only: they can see comments but not add them. allowed: they can see and add comments, which writes to your workspace.

customFields'hidden' | 'read_only' | 'editable' required

What visitors can do with custom field values. hidden: they can't see them. read_only: they can see them. editable: they can change them, which writes to your workspace. This controls what visitors are allowed to do, not whether the Air share page shows its info panel.

createdAtstring date-time required

Changes