Passer au contenu principal
PUT
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

dashboard
string
requis

L'ID du tableau de bord, un UUID.

Corps

application/json

Qui peut ouvrir un tableau de bord.

visibility
enum<string>
requis

Qui peut l'ouvrir : private pour son propriétaire seulement, roles pour les membres détenant les rôles nommés, ou organization pour tous les membres.

Options disponibles:
private,
roles,
organization
roles
string[]

Pour roles, les noms des rôles dont les membres peuvent l'ouvrir. 50 au plus.

Maximum array length: 50
Maximum string length: 255

Réponse

DashboardSavedResource

data
DashboardSavedResource · object
requis

Un tableau de bord tel qu'il est après un enregistrement ou un changement de partage. Lisez le tableau de bord par son ID pour le reste.