member_fields

Dirección de petición

Centro de datos	URL
Singapur	https://email.api.engagelab.cc
Turquía	https://emailapi-tr.engagelab.com

Al utilizar la API REST, se debe verificar que el centro de datos seleccionado corresponda a la URL base adecuada.

POST/v1/marketing/lists/fields

Crear

URL

https://email.api.engagelab.cc/v1/marketing/lists/fields

              
              https://email.api.engagelab.cc/v1/marketing/lists/fields

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

POST

              
              POST

Este bloque de código se muestra en una ventana flotante

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
field_name	string	true	Nombre del campo (máximo 64 caracteres, compuesto únicamente por a-z, A-Z, 0-9, _ y no puede ser una cadena de campo definida por el sistema; incluidos los campos del sistema Email, Name, Phone; se pueden crear un total de 50 campos)
field_type	integer	true	Tipo de campo (0: texto, 1: número, 2: fecha, 3: cumpleaños, 4: lista desplegable)
visible	boolean	true	Si es visible, true o false
format	string	false	Formato de datos: 0 o .0 o .00 (cuando field_type=1); MM/DD/YYYY o DD/MM/YYYY (cuando field_type=2); MM/DD o DD/MM (cuando field_type=3)
options	string[]	false	Lista de elementos para el tipo lista desplegable; no puede estar vacía cuando field_type es lista desplegable; máximo 10 elementos de datos

Nota:

Campos del sistema: Email, Name, Phone, Tag, Campaign, Segment, Domain, CreateTime, UpdateTime, UnsubscribeTime.
Los nombres de campo no pueden ser campos del sistema, y tampoco se permite crear uno cambiando únicamente el uso de mayúsculas/minúsculas.

Ejemplo de solicitud

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields --data '{ "field_name": "xiao", "field_type": 3, "visible": true, "format": "MM/DD" }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields --data '{
  "field_name": "xiao",
  "field_type": 3,
  "visible": true,
  "format": "MM/DD"
}'

Este bloque de código se muestra en una ventana flotante

Response-Success

HttpStatus: 200

{ "result": { "field_id": 11, "field_name": "xiao", "field_type": 3, "visible": true, "format": "MM/DD" } }

              
              { 
 "result": {
   "field_id": 11,
  "field_name": "xiao",
  "field_type": 3,
  "visible": true,
  "format": "MM/DD"
  }
}

Este bloque de código se muestra en una ventana flotante

Response-Error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed" }

              
              {
  "code": 30000,
  "message": "Authentication failed"
}

Este bloque de código se muestra en una ventana flotante

Eliminar

URL

https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

DELETE

              
              DELETE

Este bloque de código se muestra en una ventana flotante

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Ejemplo de solicitud

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/569

              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/569

Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Este bloque de código se muestra en una ventana flotante

Response-Error

{ "code": 30037, "message": "delete failure" }

              
              {
  "code": 30037,
  "message": "delete failure"
}

Este bloque de código se muestra en una ventana flotante

Actualizar

URL

https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

PUT

PUT

Este bloque de código se muestra en una ventana flotante

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
field_name	string	true	Nombre del campo (máximo 64 caracteres, compuesto únicamente por a-z, A-Z, 0-9, _, y no puede ser una cadena de campo definida por el sistema (sin distinguir mayúsculas/minúsculas); se pueden crear un total de 50 campos, incluidos campos del sistema Email, Name, Phone)
field_type	integer	true	Tipo de campo (0: texto, 1: número, 2: fecha, 3: cumpleaños, 4: lista desplegable)
visible	boolean	true	Si es visible, true o false
format	string	false	Formato de datos: 0 o .0 o .00 (field_type=1); MM/DD/YYYY o DD/MM/YYYY (field_type=2); MM/DD o DD/MM (field_type=3)
options	string[]	false	Contenido de los elementos de lista desplegable para el tipo lista desplegable; no debe estar vacío cuando field_type es lista desplegable, y puede tener un máximo de 10 entradas de datos.

Nota:

Campos del sistema: Email, Name, Phone, Tag, Campaign, Segment, Domain, CreateTime, UpdateTime, UnsubscribeTime

Ejemplo de solicitud

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/839 --data '{ "field_name": "xiao", "field_type": 3, "visible": true, "format": "MM/DD" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/839 --data '{
  "field_name": "xiao",
  "field_type": 3,
  "visible": true,
  "format": "MM/DD"
}'

Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
  "count": 1
}

Este bloque de código se muestra en una ventana flotante

Response-Error

{ "code": 30036, "message": "not found" }

              
              {
    "code": 30036,
    "message": "not found"
}

Este bloque de código se muestra en una ventana flotante

Lista de campos

URL

https://email.api.engagelab.cc/v1/marketing/lists/fields

              
              https://email.api.engagelab.cc/v1/marketing/lists/fields

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
field_name	string	false	Nombre del campo, consulta difusa

Ejemplo de solicitud

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields?field_name=Age

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields?field_name=Age

Este bloque de código se muestra en una ventana flotante

Parámetros de respuesta

Parámetro	Tipo	Descripción
result	array[object]	Lista de campos
field_name	string	Nombre del campo (hasta 64 caracteres, compuesto únicamente por a-z, A-Z, 0-9, _, y no puede ser una cadena de campo definida por el sistema (sin distinguir mayúsculas/minúsculas); se pueden crear un total de 50 campos, incluidos campos del sistema como Email, Name, Phone)
field_type	integer	Tipo de campo (0: texto, 1: número, 2: fecha, 3: cumpleaños, 4: lista desplegable)
visible	boolean	Visibilidad (true o false)
format	string	Formato de datos: 0 o .0 o .00 (field_type=1); MM/DD/YYYY o DD/MM/YYYY (field_type=2); MM/DD o DD/MM (field_type=3)
options	string[]	Contenido de la lista desplegable para el tipo lista desplegable; no debe estar vacío cuando field_type es lista desplegable; máximo 10 entradas de datos
field_id	integer	Índice correspondiente al campo; -1 indica un campo del sistema
total	integer	Número total de registros que coinciden con la consulta
count	integer	Número de registros que coinciden con la consulta en este resultado

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "result": [ { "field_name": "Email", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": -1 }, { "field_name": "Name", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": -1 }, { "field_name": "Phone", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": -1 }, { "field_name": "Gender", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": 0 }, { "field_name": "Birthday", "field_type": 3, "visible": true, "format": "MM/DD", "options": null, "field_id": 1 }, { "field_name": "Age", "field_type": 1, "visible": true, "format": "0", "options": null, "field_id": 2 }, { "field_name": "remark", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": 3 } ], "total": 7, "count": 7 }

              
              {
  "result": [
    {
      "field_name": "Email",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": -1
    },
    {
      "field_name": "Name",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": -1
    },
    {
      "field_name": "Phone",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": -1
    },
    {
      "field_name": "Gender",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": 0
    },
    {
      "field_name": "Birthday",
      "field_type": 3,
      "visible": true,
      "format": "MM/DD",
      "options": null,
      "field_id": 1
    },
    {
      "field_name": "Age",
      "field_type": 1,
      "visible": true,
      "format": "0",
      "options": null,
      "field_id": 2
    },
    {
      "field_name": "remark",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": 3
    }
  ],
  "total": 7,
  "count": 7
}

Este bloque de código se muestra en una ventana flotante

Response-Error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed" }

              
              {
  "code": 30000,
  "message": "Authentication failed"
}

Este bloque de código se muestra en una ventana flotante

Campos de miembro

Dirección de petición

Crear

Eliminar

Actualizar

Lista de campos