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

connection
string
requis

L'ID de la connexion de messagerie.

Corps

application/json

Où une connexion de clavardage publie les alertes et lesquelles, pour la page et l'API.

alert_on_sync_failed
boolean
requis

Indique s'il faut publier lorsqu'une exécution de synchronisation échoue ou se termine avec des enregistrements en échec.

alert_on_needs_attention
boolean
requis

Indique s'il faut publier lorsqu'une connexion exige que quelqu'un se reconnecte ou la rétablisse.

alert_channel
string | null

L'ID du canal chez le fournisseur, par exemple le C0123ABCD de Slack, tel que le renvoie la liste des canaux de messagerie. Envoyez null pour aucun canal d'alerte. Un fournisseur lié à un seul canal l'ignore.

Maximum string length: 32
Pattern: ^[CG][A-Z0-9]{2,31}$
alert_channel_name
string | null

Le nom du canal tel que le renvoie la liste des canaux de messagerie, affiché à côté du canal.

Maximum string length: 90

Réponse

ConnectionResource

data
ConnectionResource · object
requis

Une connexion entre l'organisation et un système externe, comme une boutique, un transporteur ou un grand livre comptable. Elle n'inclut jamais de jeton, de clé ni de secret : ils sont conservés chiffrés et ne peuvent pas être lus par l'API.