Exportar atributos personalizados

Utiliza este punto final para exportar una lista de atributos personalizados registrados para tu aplicación. Los atributos se devuelven en grupos de 50, ordenados alfabéticamente.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso custom_attributes.get.

Límite de velocidad

Parámetros de consulta

Ten en cuenta que cada llamada a este punto final devolverá 50 atributos. Para más de 50 atributos, utiliza la cabecera Link para recuperar los datos en la página siguiente, como se muestra en el siguiente ejemplo de respuesta.

Ejemplos de solicitudes

Sin cursor

1
2
3
curl --location --request GET 'https://rest.iad-01.braze.com/custom_attributes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Con cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/custom_attributes?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Respuesta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "attributes" : [
        {
            "array_length": 100, (number) the maximum array length, or null if not applicable,
            "data_type": "Number", (string) the data type,
            "description": "The attribute description", (string) the attribute description,
            "name": "The attribute name", (string) the attribute name,
            "status": "Active", (string) the attribute status,
            "tag_names": ["Tag One", "Tag Two"] (array) the tag names associated with the attribute formatted as strings,
        },
        ...
    ]
}

Códigos de respuesta de error fatal

Para conocer los códigos de estado y los mensajes de error asociados que se devolverán si tu solicitud encuentra un error fatal, consulta Errores fatales.