Logo Site EngageLab Mark Colored TransparentDokumentation
E-Mail
Doku-Startseite
SchnellstartAnweisungenREST APISMTPUseMarketingWebHookRessourcen herunterladen
Suchen
Anmelden
REST API/Marketing/Verwaltung von Aufgabetags
REST APIMarketingVerwaltung von Aufgabetags...

Verwaltung von Aufgabetags

Zuletzt aktualisiert：18 days ago

Aufrufadresse

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

Bei der Verwendung der REST-API muss die ausgewählte Basis-URL mit dem Pfad der jeweiligen API kombiniert werden, um die vollständige Anrufadresse zu erhalten.

POST/v1/marketing/campaigns/tags

Erstellen von Aufgabetags

URL

https://email.api.engagelab.cc/v1/marketing/campaigns/tags
              
              https://email.api.engagelab.cc/v1/marketing/campaigns/tags
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

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

Anfragen-Header

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Body-Parameter

Parameter Type Required Description
tag_names array[string] true Der Name des Labels kann bis zu 64 Zeichen umfassen. Er besteht ausschließlich aus den Zeichen a-z, A-z, 0-9, _, sowie chinesischen Schriftzeichen.

Erklärung:

1、Jede Organisation kann maximal 100 Tags erstellen.

2、Die Bezeichnungen der Etiketten dürfen nicht doppelt vorkommen.

Beispiel für eine Anfrage

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags --data '{ "tag_names": ["Doppel-11-Werbeaktion", "Neuer Nutzer"] }'
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags --data '{
    "tag_names": ["Doppel-11-Werbeaktion", "Neuer Nutzer"]
}'
Diesen Codeblock im schwebenden Fenster anzeigen

Beispiele für Antworten

Response-Success

HttpStatus: 200

{ "count": 2 }
              
              {
    "count": 2
}
Diesen Codeblock im schwebenden Fenster anzeigen

Response-Error

HttpStatus: 401

{ "code": 32603, "message": "tag name already exist" }
              
              {
    "code": 32603,
    "message": "tag name already exist"
}
Diesen Codeblock im schwebenden Fenster anzeigen

Liste der Aufgabenzuweisungen

URL

https://email.api.engagelab.cc/v1/marketing/campaigns/tags
              
              https://email.api.engagelab.cc/v1/marketing/campaigns/tags
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

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

Anfragen-Header

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Query-Parameter

Parameter Type Required Description
tag_name string false Labelname (ungefähre Suche)
offset integer false Speichern Sie die Abweichung. Der Wertebereich liegt zwischen 0 und Unendlich. Der Standardwert beträgt 0.
limit integer false Erhaltung der Anzahl der Einträge. Wertebereich: [1–100]. Standardwert: 10

Beispiel für eine Anfrage

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=Promotion&limit=10&offset=0
              
              curl -X GET -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=Promotion&limit=10&offset=0
Diesen Codeblock im schwebenden Fenster anzeigen

Erklärung zur Reaktion

Parameter Type Description
tag_id string tag-ID
tag_name string Labelname
create_time string Erstellungszeit
update_time string Aktualisierungszeit

Beispiele für Antworten

Response-Success

HttpStatus: 200

{ "result": [ { "tag_id": "64a1f2e0c9e1a23456789012", "tag_name": "Doppel-11-Werbeaktion", "create_time": "2024-01-15T10:30:00+0800", "update_time": "2024-01-16T14:20:00+0800" }, { "tag_id": "64a1f2e0c9e1a23456789013", "tag_name": "Neuer Nutzer", "create_time": "2024-01-14T08:00:00+0800", "update_time": "2024-01-14T08:00:00+0800" } ], "total": 2, "count": 2 }
              
              {
    "result": [
        {
            "tag_id": "64a1f2e0c9e1a23456789012",
            "tag_name": "Doppel-11-Werbeaktion",
            "create_time": "2024-01-15T10:30:00+0800",
            "update_time": "2024-01-16T14:20:00+0800"
        },
        {
            "tag_id": "64a1f2e0c9e1a23456789013",
            "tag_name": "Neuer Nutzer",
            "create_time": "2024-01-14T08:00:00+0800",
            "update_time": "2024-01-14T08:00:00+0800"
        }
    ],
    "total": 2,
    "count": 2
}
Diesen Codeblock im schwebenden Fenster anzeigen

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }
              
              {
    "code": 30000,
    "message": "Authentication failed"
}
Diesen Codeblock im schwebenden Fenster anzeigen

Aktualisierung der Aufgabetags

URL

https://email.api.engagelab.cc/v1/marketing/campaigns/tags/{tag_id}
              
              https://email.api.engagelab.cc/v1/marketing/campaigns/tags/{tag_id}
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

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

Anfragen-Header

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Body-Parameter

Parameter Type Required Description
tag_id string true tag-ID

Body 参数

Parameter Type Required Description
tag_name string true Der Name des Labels kann nur aus chinesischen Zeichen, Groß- und Kleinschreibung des Englischen, Ziffern sowie Bindestrichen bestehen. Die Länge darf 1 bis 64 Zeichen betragen.

Beispiel für eine Anfrage

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012 --data '{ "tag_name": "Promotion" }'
              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012 --data '{
    "tag_name": "Promotion"
}'
Diesen Codeblock im schwebenden Fenster anzeigen

Beispiele für Antworten

Response-Success

HttpStatus: 200

{ "count": 1 }
              
              {
    "count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Diesen Codeblock im schwebenden Fenster anzeigen

Löschen des Aufgabentags

URL

https://email.api.engagelab.cc/v1/marketing/campaigns/tags
              
              https://email.api.engagelab.cc/v1/marketing/campaigns/tags
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

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

Anfragen-Header

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Erklärung:

1、Nach dem Lösen des Tags wird das zugehörige Campaign automatisch von diesem Tag befreit.

Beispiel für eine Anfrage

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f
              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f
Diesen Codeblock im schwebenden Fenster anzeigen

Beispiele für Antworten

Response-Success

HttpStatus: 200

{ "count": 2 }
              
              {
    "count": 2
}
Diesen Codeblock im schwebenden Fenster anzeigen

Response-Error

HttpStatus: 401

{ "code": 32606, "message": "tag_id cannot be empty" }
              
              {
    "code": 32606,
    "message": "tag_id cannot be empty"
}
Diesen Codeblock im schwebenden Fenster anzeigen

Zuweisung von Tags zu Aufgaben

URL

https://email.api.engagelab.cc/v1/marketing/campaigns/tags/{tag_id}/add
              
              https://email.api.engagelab.cc/v1/marketing/campaigns/tags/{tag_id}/add
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

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

Anfragen-Header

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Body-Parameter

Parameter Type Required Description
campaign_ids array[string] * Liste der Aufgaben-ID’s – maximal 200 Einträge pro Aufruf

Erklärung:

1、Pro Kampagne können maximal 20 Tags hinzugefügt werden.

Beispiel für eine Anfrage

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add --data '{ "campaign_ids": [ "61c2be010d2b4e6a3836ab1f", "61c2be010d2b4e6a3836ab1d" ] }'
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'
Diesen Codeblock im schwebenden Fenster anzeigen

Beispiele für Antworten

Response-Success

HttpStatus: 200

{ "total": 3 }
              
              {
    "total": 3
}
Diesen Codeblock im schwebenden Fenster anzeigen

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Diesen Codeblock im schwebenden Fenster anzeigen

Aufgabe: Entfernen von Tags

URL

https://email.api.engagelab.cc/v1/marketing/campaigns/tags/{tag_id}/remove
              
              https://email.api.engagelab.cc/v1/marketing/campaigns/tags/{tag_id}/remove
Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

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

Anfragen-Header

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Body-Parameter

Parameter Type Required Description
campaign_ids array[string] * Liste der Aufgaben-ID’s – maximal 200 Einträge pro Aufruf

Beispiel für eine Anfrage

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove --data '{ "campaign_ids": [ "61c2be010d2b4e6a3836ab1f", "61c2be010d2b4e6a3836ab1d" ] }'
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'
Diesen Codeblock im schwebenden Fenster anzeigen

Beispiele für Antworten

Response-Success

HttpStatus: 200

{ "total": 3 }
              
              {
    "total": 3
}
Diesen Codeblock im schwebenden Fenster anzeigen

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Icon Solid Transparent White Qiyu
Vertrieb kontaktieren