member_fields

Aufrufadresse

Rechenzentrum	URL
Singapur	https://email.api.engagelab.cc
Türkei	https://emailapi-tr.engagelab.com

Bei der Nutzung der REST API ist sicherzustellen, dass das gewählte Rechenzentrum der entsprechenden Basis-URL entspricht.

POST/v1/marketing/lists/fields

Erstellen

URL

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(api_user:api_key)

Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
field_name	string	ja	Feldname (maximal 64 Zeichen, nur a-z, A-Z, 0-9, _, darf kein systemdefinierter Feldname sein; inklusive Systemfelder Email, Name, Phone können insgesamt 50 Felder erstellt werden)
field_type	integer	ja	Feldtyp (0: Text, 1: Zahl, 2: Datum, 3: Geburtstag, 4: Dropdown)
visible	boolean	ja	Sichtbar, true oder false
format	string	nein	Datenformat: 0 oder .0 oder .00 (bei field_type=1); MM/DD/YYYY oder DD/MM/YYYY (bei field_type=2); MM/DD oder DD/MM (bei field_type=3)
options	string[]	nein	Liste der Dropdown-Elemente, darf bei field_type=4 nicht leer sein, maximal 10 Einträge

Hinweis:

Systemfelder: Email, Name, Phone, Tag, Campaign, Segment, Domain, CreateTime, UpdateTime, UnsubscribeTime.
Feldnamen dürfen keine Systemfelder sein; auch eine Änderung der Groß-/Kleinschreibung ist nicht zulässig (Groß-/Kleinschreibung wird ignoriert, d. h. case-insensitive).

Beispiel-Request

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"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Erfolgsantwort

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"
  }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort

HTTP Status :401

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen" }

              
              {
  "code": 30000,
  "message": "Authentifizierung fehlgeschlagen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Löschen

URL

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

DELETE

              
              DELETE

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(api_user:api_key)

Beispiel-Request

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

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel-Antwort

Erfolgsantwort

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort

{ "code": 30037, "message": "Löschvorgang fehlgeschlagen" }

              
              {
  "code": 30037,
  "message": "Löschvorgang fehlgeschlagen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Aktualisieren

URL

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

PUT

PUT

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(api_user:api_key)

Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
field_name	string	ja	Feldname (maximal 64 Zeichen, nur a-z, A-Z, 0-9, _, darf kein systemdefinierter Feldname sein (Groß-/Kleinschreibung wird ignoriert, d. h. case-insensitive); inklusive Systemfelder Email, Name, Phone können insgesamt 50 Felder erstellt werden)
field_type	integer	ja	Feldtyp (0: Text, 1: Zahl, 2: Datum, 3: Geburtstag, 4: Dropdown)
visible	boolean	ja	Sichtbar, true oder false
format	string	nein	Datenformat: 0 oder .0 oder .00 (field_type=1); MM/DD/YYYY oder DD/MM/YYYY (field_type=2); MM/DD oder DD/MM (field_type=3)
options	string[]	nein	Inhalte der Dropdown-Liste für Dropdown-Typ; darf bei field_type=4 nicht leer sein, maximal 10 Einträge.

Hinweis:

Systemfelder: Email, Name, Phone, Tag, Campaign, Segment, Domain, CreateTime, UpdateTime, UnsubscribeTime.

Beispiel-Request

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"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beispiel-Antwort

Erfolgsantwort

HttpStatus: 200

{ "count": 1 }

              
              {
  "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort

{ "code": 30036, "message": "nicht gefunden" }

              
              {
    "code": 30036,
    "message": "nicht gefunden"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Feldliste

URL

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Request-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	string	ja	Basic base64(api_user:api_key)

Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung
field_name	string	nein	Feldname, unscharfe Suche (Fuzzy Search)

Beispiel-Request

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

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Parameter

Parameter	Typ	Beschreibung
result	array[object]	Feldliste
field_name	string	Feldname (bis zu 64 Zeichen, nur a-z, A-Z, 0-9, _, darf kein systemdefinierter Feldname sein (Groß-/Kleinschreibung wird ignoriert, d. h. case-insensitive); insgesamt 50 Felder inkl. Systemfelder wie Email, Name, Phone möglich)
field_type	integer	Feldtyp (0: Text, 1: Zahl, 2: Datum, 3: Geburtstag, 4: Dropdown)
visible	boolean	Sichtbarkeit (true oder false)
format	string	Datenformat: 0 oder .0 oder .00 (field_type=1); MM/DD/YYYY oder DD/MM/YYYY (field_type=2); MM/DD oder DD/MM (field_type=3)
options	string[]	Dropdown-Inhalte für Dropdown-Typ, darf bei field_type=4 nicht leer sein, maximal 10 Einträge
field_id	integer	Index des Feldes, -1 steht für ein Systemfeld
total	integer	Gesamtanzahl der zur Abfrage passenden Datensätze
count	integer	Anzahl der Datensätze im aktuellen Abfrageergebnis

Beispiel-Antwort

Erfolgsantwort

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
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort

HTTP Status :401

{ "code": 30000, "message": "Authentifizierung fehlgeschlagen" }

              
              {
  "code": 30000,
  "message": "Authentifizierung fehlgeschlagen"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Member_Felder

Aufrufadresse

Erstellen

Löschen

Aktualisieren

Feldliste