Logo Site EngageLab Mark Colored TransparentDokumen
Email
Beranda Dokumen
Mulai CepatInstruksiREST APISMTPGunakan PemasaranWebHookUnduhan Sumber Daya
Cari
Masuk
REST API/Pemasaran/Manajemen Tag Kampanye
REST APIPemasaranManajemen Tag Kampanye...

Manajemen Tag Kampanye

Terakhir diperbarui：18 hari yang lalu

Endpoint

Pusat Data URL
Singapura https://email.api.engagelab.cc
Turki https://emailapi-tr.engagelab.com

Saat menggunakan REST API, gabungkan base URL yang dipilih dengan jalur API spesifik untuk mendapatkan URL endpoint yang lengkap.

POST/v1/marketing/campaigns/tags

Membuat Tag Kampanye

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
Tampilkan blok kode ini di jendela mengambang

Metode HTTP

POST
              
              POST
Tampilkan blok kode ini di jendela mengambang

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Header Permintaan (Request Headers)

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

Parameter Body (Body Parameters)

Parameter Type Required Description
tag_names array[string] true Nama tag. Panjang maksimum: 64 karakter. Hanya mendukung a-z, A-Z, 0-9, _, karakter Mandarin, dll.

Catatan:

  1. Setiap organisasi dapat membuat hingga 100 tag.

  2. Nama tag harus unik.

Contoh Permintaan (Request Example)

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](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{ "tag_names": ["promosi_harbolnas", "pengguna_baru"] }'
              
              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](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{
    "tag_names": ["promosi_harbolnas", "pengguna_baru"]
}'
Tampilkan blok kode ini di jendela mengambang

Contoh Respons (Response Example)

Response-Success

HttpStatus: 200

{ "count": 2 }
              
              {
    "count": 2
}
Tampilkan blok kode ini di jendela mengambang

Response-Error

HttpStatus: 401

{ "code": 32603, "message": "tag name already exist" }
              
              {
    "code": 32603,
    "message": "tag name already exist"
}
Tampilkan blok kode ini di jendela mengambang

Daftar Tag Kampanye

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
Tampilkan blok kode ini di jendela mengambang

Metode HTTP

GET
              
              GET
Tampilkan blok kode ini di jendela mengambang

Content-Type

application/x-www-form-urlencoded;charset=utf-8
              
              application/x-www-form-urlencoded;charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Header Permintaan (Request Headers)

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

Parameter Kueri (Query Parameters)

Parameter Type Required Description
tag_name string false Nama tag (pencarian kabur/fuzzy search)
offset integer false Offset rekaman. Rentang nilai: [0-]. Default: 0
limit integer false Jumlah rekaman yang akan diambil. Rentang nilai: [1-100]. Default: 10

Contoh Permintaan (Request Example)

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promosi&limit=10&offset=0](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promosi&limit=10&offset=0)
              
              curl -X GET -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promosi&limit=10&offset=0](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promosi&limit=10&offset=0)
Tampilkan blok kode ini di jendela mengambang

Bidang Respons (Response Fields)

Parameter Type Description
tag_id string ID Tag
tag_name string Nama tag
create_time string Waktu pembuatan
update_time string Waktu pembaruan

Contoh Respons (Response Example)

Response-Success

HttpStatus: 200

{ "result": [ { "tag_id": "64a1f2e0c9e1a23456789012", "tag_name": "promosi_harbolnas", "create_time": "2024-01-15T10:30:00+0800", "update_time": "2024-01-16T14:20:00+0800" }, { "tag_id": "64a1f2e0c9e1a23456789013", "tag_name": "pengguna_baru", "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": "promosi_harbolnas",
            "create_time": "2024-01-15T10:30:00+0800",
            "update_time": "2024-01-16T14:20:00+0800"
        },
        {
            "tag_id": "64a1f2e0c9e1a23456789013",
            "tag_name": "pengguna_baru",
            "create_time": "2024-01-14T08:00:00+0800",
            "update_time": "2024-01-14T08:00:00+0800"
        }
    ],
    "total": 2,
    "count": 2
}
Tampilkan blok kode ini di jendela mengambang

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }
              
              {
    "code": 30000,
    "message": "Authentication failed"
}
Tampilkan blok kode ini di jendela mengambang

Memperbarui Tag Kampanye

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}
Tampilkan blok kode ini di jendela mengambang

Metode HTTP

PUT
              
              PUT
Tampilkan blok kode ini di jendela mengambang

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Header Permintaan (Request Headers)

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

Parameter Jalur (Path Parameters)

Parameter Type Required Description
tag_id string true ID Tag

Parameter Body (Body Parameters)

Parameter Type Required Description
tag_name string true Nama tag. Hanya mendukung karakter Mandarin, huruf Inggris besar dan kecil, angka, serta garis bawah (_). Panjang: 1-64 karakter.

Contoh Permintaan (Request Example)

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](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{ "tag_name": "promosi_midyear" }'
              
              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](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{
    "tag_name": "promosi_midyear"
}'
Tampilkan blok kode ini di jendela mengambang

Contoh Respons (Response Example)

Response-Success

HttpStatus: 200

{ "count": 1 }
              
              {
    "count": 1
}
Tampilkan blok kode ini di jendela mengambang

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Tampilkan blok kode ini di jendela mengambang

Menghapus Tag Kampanye

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
Tampilkan blok kode ini di jendela mengambang

Metode HTTP

DELETE
              
              DELETE
Tampilkan blok kode ini di jendela mengambang

Content-Type

application/x-www-form-urlencoded;charset=utf-8
              
              application/x-www-form-urlencoded;charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Header Permintaan (Request Headers)

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

Catatan:

  1. Setelah tag dihapus, kampanye yang terkait akan secara otomatis melepaskan tag tersebut.

Contoh Permintaan (Request Example)

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f](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](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f)
Tampilkan blok kode ini di jendela mengambang

Contoh Respons (Response Example)

Response-Success

HttpStatus: 200

{ "count": 2 }
              
              {
    "count": 2
}
Tampilkan blok kode ini di jendela mengambang

Response-Error

HttpStatus: 401

{ "code": 32606, "message": "tag_id cannot be empty" }
              
              {
    "code": 32606,
    "message": "tag_id cannot be empty"
}
Tampilkan blok kode ini di jendela mengambang

Menambahkan Tag ke Kampanye

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add
Tampilkan blok kode ini di jendela mengambang

Metode HTTP

POST
              
              POST
Tampilkan blok kode ini di jendela mengambang

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Header Permintaan (Request Headers)

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

Parameter Body (Body Parameters)

Parameter Type Required Description
campaign_ids array[string] * Daftar ID Kampanye. Maksimum 200 ID per permintaan.

Catatan:

  1. Setiap kampanye dapat memiliki maksimum 20 tag.

Contoh Permintaan (Request Example)

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](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](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'
Tampilkan blok kode ini di jendela mengambang

Contoh Respons (Response Example)

Response-Success

HttpStatus: 200

{ "total": 3 }
              
              {
    "total": 3
}
Tampilkan blok kode ini di jendela mengambang

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Tampilkan blok kode ini di jendela mengambang

Menghapus Tag dari Kampanye

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove
Tampilkan blok kode ini di jendela mengambang

Metode HTTP

POST
              
              POST
Tampilkan blok kode ini di jendela mengambang

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Header Permintaan (Request Headers)

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

Parameter Body (Body Parameters)

Parameter Type Required Description
campaign_ids array[string] * Daftar ID Kampanye. Maksimum 200 ID per permintaan.

Contoh Permintaan (Request Example)

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](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](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'
Tampilkan blok kode ini di jendela mengambang

Contoh Respons (Response Example)

Response-Success

HttpStatus: 200

{ "total": 3 }
              
              {
    "total": 3
}
Tampilkan blok kode ini di jendela mengambang

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Tampilkan blok kode ini di jendela mengambang
Icon Solid Transparent White Qiyu
Hubungi Sales