EstadoDesarrolladoresSociosPTENESIniciar sesión
Habla con ventasEmpieza gratis
Empieza gratis
Habla con ventasEmpieza gratis
Iniciar sesiónEstadoPTENES

Referencia de la API

Atributos de contacto

Define los atributos personalizados de los contactos de tu organización, con tipo y etiqueta, y lee el diccionario que valida el campo attributes.

  • 2 operaciones
  • URL basehttps://api.messages.ccxcompany.co
  • AutenticaciónBearer con tu clave de API

El texto técnico de abajo viene del contrato público, openapi.json, en el idioma en que se escribió el contrato.

List the org's typed custom attribute definitions

GET/v2/organizations/me/custom-attribute-defs

Returns the dictionary that drives Contact.attributes validation. Returns { defs: [] } for orgs that haven't configured any.

Auth: contacts:read — every member that can read contacts also needs the schema to render the editor.

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    CampoTipoDescripción
    defsobligatorioobject[]
    defs[].keyobligatoriostring
    defs[].typeobligatoriostringValores:stringnumberbooleandate
    defs[].labelopcionalstring
    defs[].requiredobligatorioboolean
    JSON
    {  "defs": [    {      "key": "string",      "type": "string",      "label": "string",      "required": true    }  ]}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL
curl 'https://api.messages.ccxcompany.co/v2/organizations/me/custom-attribute-defs' \  -H "Authorization: Bearer $CCX_API_KEY"
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Replace the org's typed custom attribute definitions

PUT/v2/organizations/me/custom-attribute-defs

Full replace — caller passes { defs: [...] } matching the wire schema. Drop a key by omitting it.

Service rejects duplicate keys (CONFLICT) and arrays > 50 entries (VALIDATION_ERROR via Zod).

A definition that looks like a document, password, card or token (by key OR label) and still has values stored in contacts cannot be dropped nor relabeled: 409 with meta.code = PROPRIEDADE_SENSIVEL_EM_USO (clear the values first). If the check does not fit in 5 s, 503.

Cuerpo de la peticiónapplication/json

CampoTipoDescripción
defsobligatorioobject[]
defs[].keyobligatoriostring
defs[].typeobligatoriostringValores:stringnumberbooleandate
defs[].labelopcionalstring
defs[].requiredopcionalboolean
Ejemplo completo del cuerpo
JSON
{  "defs": [    {      "key": "string",      "type": "string",      "label": "string",      "required": true    }  ]}

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    CampoTipoDescripción
    defsobligatorioobject[]
    JSON
    {  "defs": [    {}  ]}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 409RFC 7807 problem details for CONFLICT (409).

  • 422RFC 7807 problem details for VALIDATION_ERROR (422).

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL
curl -X PUT 'https://api.messages.ccxcompany.co/v2/organizations/me/custom-attribute-defs' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "defs": [      {        "key": "string",        "type": "string"      }    ]  }'
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Otras áreas de la API

¿Atascado en una ruta? Habla con quienes mantienen la API.

Empieza gratisHabla con ventas

Si creas la cuenta desde la web, recibes 5 US$ de crédito de prueba.