Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Cuerpo

application/json

Un campo personalizado nuevo para artículos.

key
string
requerido

La clave con la que se guarda el valor del campo en los custom_fields de un artículo: una letra minúscula, y luego hasta 39 letras minúsculas, dígitos o guiones bajos. No puede cambiar después.

Pattern: ^[a-z][a-z0-9_]{0,39}$
label
string
requerido

El nombre del campo tal como lo ven los miembros, de hasta 100 caracteres.

Maximum string length: 100
type
enum<string>
requerido

Lo que contiene el campo: text, number, date, boolean o select.

Opciones disponibles:
text,
number,
date,
boolean,
select
classification
enum<string>
requerido

Qué tan sensibles son los valores del campo: internal o confidential. Los valores confidenciales se cifran, solo los ven los miembros que pueden ver artículos confidenciales y no se pueden usar para filtrar.

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

Los valores que permite un campo select, hasta 50, cada uno de máximo 100 caracteres y único. Es obligatorio cuando type es select.

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

Si cada artículo debe tener un valor para el campo. El valor predeterminado es false.

Respuesta

CustomFieldResource

data
CustomFieldResource · object
requerido

Un campo personalizado que la organización definió para artículos. Cada artículo puede guardar un valor para él, bajo su clave en custom_fields.