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

field
string
requis

La clé du champ personnalisé, comme material.

Corps

application/json

Une modification d'un champ personnalisé d'article. La clé du champ vient du chemin et ne change jamais.

label
string
requis

Le nom du champ tel que les membres le voient, 100 caractères au plus.

Maximum string length: 100
type
enum<string>
requis

Ce que contient le champ : text, number, date, boolean ou select.

Options disponibles:
text,
number,
date,
boolean,
select
classification
enum<string>
requis

Le degré de confidentialité des valeurs du champ : internal ou confidential. Les valeurs confidentielles sont chiffrées, affichées seulement aux membres autorisés à voir les articles confidentiels, et ne peuvent pas servir de filtre.

Options disponibles:
internal,
confidential
options
string[] | null

Les valeurs qu'un champ select permet, jusqu'à 50, chacune d'au plus 100 caractères et unique. Obligatoire lorsque type est select.

Maximum array length: 50
Maximum string length: 100
required
boolean

Indique si chaque article doit avoir une valeur pour le champ. false par défaut.

Réponse

CustomFieldResource

data
CustomFieldResource · object
requis

Un champ personnalisé que l'organisation a défini pour les articles. Chaque article peut y contenir une valeur, sous sa clé dans custom_fields.