İçeriğe geç
Admin API

Maillist

Serverhttps://magaza-adiniz.myideasoft.com

Maillist LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/maillists
Bearer
or
OAuth 2.0

Tüm E-posta Abone (Maillist) nesnelerini filtreleyerek ve sayfalandırarak listeler.Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

Maillist LIST › query Parameters

sort
​string

Sonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

sinceId
​integer · min: 1

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

q
​string

Gelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama Anahtarı Filtresi (Search Keyword). E-posta adresi veya ilgili alanlarda genel arama yaparak dışa aktarmayı filtreler.

maillistGroup
​integer · min: 1

Sonuçları belirli bir E-posta Listesi Grup ID'sine (Maillist Group ID) göre filtreler.

Maillist LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
name
​string · maxLength: 255

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string

Mail adresi.

Example: mail@example.com
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
​MaillistGroupSummary
createdAt
​string · date-time

Mail listesi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Mail listesi nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

Maillist POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/maillists
Bearer
or
OAuth 2.0

Maillist POST › Request Body

id
​integer · required

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
name
​string · maxLength: 255

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string

Mail adresi.

Example: mail@example.com
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
​MaillistGroupSummary
createdAt
​string · date-time

Mail listesi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Mail listesi nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

Maillist POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

id
​integer · required

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
name
​string · maxLength: 255

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string

Mail adresi.

Example: mail@example.com
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
​MaillistGroupSummary
createdAt
​string · date-time

Mail listesi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Mail listesi nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

Maillist COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/maillists/count
Bearer
or
OAuth 2.0

Tüm E-posta Abone (Maillist) nesnelerini filtreleyerek ve sayfalandırarak listeler.Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

Maillist COUNT › query Parameters

sort
​string

Sonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

sinceId
​integer · min: 1

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

q
​string

Gelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama Anahtarı Filtresi (Search Keyword). E-posta adresi veya ilgili alanlarda genel arama yaparak dışa aktarmayı filtreler.

maillistGroup
​integer · min: 1

Sonuçları belirli bir E-posta Listesi Grup ID'sine (Maillist Group ID) göre filtreler.

Maillist COUNT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.


Maillist GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/maillists/{id}
Bearer
or
OAuth 2.0

Maillist GET › path Parameters

id
​string · pattern: \d+ · required

Maillist GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
name
​string · maxLength: 255

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string

Mail adresi.

Example: mail@example.com
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
​MaillistGroupSummary
createdAt
​string · date-time

Mail listesi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Mail listesi nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

Maillist PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/maillists/{id}
Bearer
or
OAuth 2.0

Maillist PUT › path Parameters

id
​string · pattern: \d+ · required

Maillist PUT › Request Body

id
​integer · required

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
name
​string · maxLength: 255

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string

Mail adresi.

Example: mail@example.com
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
​MaillistGroupSummary
createdAt
​string · date-time

Mail listesi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Mail listesi nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

Maillist PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
name
​string · maxLength: 255

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string

Mail adresi.

Example: mail@example.com
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
​MaillistGroupSummary
createdAt
​string · date-time

Mail listesi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Mail listesi nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

Maillist DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/admin-api/maillists/{id}
Bearer
or
OAuth 2.0

Maillist DELETE › path Parameters

id
​string · pattern: \d+ · required

Maillist DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned

Maillist BulkImportAction POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/maillists/bulk-import
Bearer
or
OAuth 2.0

Maillist BulkImportAction POST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

No data returned