Download Postman Collection
 Back to top

Setrow API Documentation

Introduction

This API documentation includes all technical informations developers need to integrate third-party applications and platforms.

Based on simple REST principles, the Setrow API endpoints return JSON data directly from the Setrow. The base address of Web API is 'https://rest.setrow.com' . The API provides a set of endpoints, each with its own unique path.

Authorization

All requests made against the Setrow API must be validated with an API Key. If you don't know your API Key yet visit the Setrow Panel to find out. You must send this API Key in the Authorization header when making requests.

Sample Usage:

Authorization: Bearer Sm5cmsOvCt0IxH8WDUYVbwkQgknKrC20dZcqfQLI9CpzafnEl5

Email Operations

Get Email Info
GET /email

It's a Setrow API feature to get the information of an e-mail address.

Example URI

GET https://rest.setrow.com/email/test@setrow.com
Response  Success
HideShow
Body
Response  Error
HideShow

Email Address Add/Update
POST /email/add

It's a Setrow API feature to add or update an e-mail address. If there is no record with this e-mail address, it adds it, if it does, it updates it. With a single request, you can perform bulk transactions with a maximum of 1000 e-mail addresses.

Example URI

POST https://rest.setrow.com/email/add
Parameters
HideShow
See all IYS values
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Email Address Transfer
POST /email/transfer

It is a Setrow API feature for transferring an email address between groups. With a single request, you can perform bulk transactions with a maximum of 1000 e-mail addresses.

Example URI

POST https://rest.setrow.com/email/transfer
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Email Address Delete
DELETE /email/delete

It is a Setrow API feature for deleting an email address from any groups. With a single request, you can perform bulk transactions with a maximum of 1000 e-mail addresses.

Example URI

DELETE https://rest.setrow.com/email/delete
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Sms Operations

Get Sms Number Info
GET /sms

It's a Setrow API feature to get the information of an sms number.

Example URI

GET https://rest.setrow.com/sms/5448848919
Response  Success
HideShow
Body
Response  Error
HideShow

Get Sms Number Report
GET /sms/report?{parameters}

It's a Setrow API feature to get the lists of sms sending reports.

Example URI

GET https://rest.setrow.com/sms/report?reportType=1&number=5448848919&startDate=2022-01-05&lastDate=2022-01-15
Parameters
HideShow
Response  Success
HideShow
Body
Response  Error
HideShow

Sms Number Add/Update
POST /sms/add

It's a Setrow API feature to add or update an sms number. If there is no record with this sms number, it adds it, if it does, it updates it. With a single request, you can perform bulk transactions with a maximum of 1000 sms numbers.

Example URI

POST https://rest.setrow.com/sms/add
Parameters
HideShow
See all IYS values
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Sms Number Transfer
POST /sms/transfer

It is a Setrow API feature for transferring an sms number between groups. With a single request, you can perform bulk transactions with a maximum of 1000 sms numbers.

Example URI

POST https://rest.setrow.com/sms/transfer
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Sms Number Delete
DELETE /sms/delete

It is a Setrow API feature for deleting an sms number from any groups. With a single request, you can perform bulk transactions with a maximum of 1000 sms numbers.

Example URI

DELETE https://rest.setrow.com/sms/delete
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Whatsapp Operations

Get Whatsapp Number Info
GET /whatsapp

It's a Setrow API feature to get the information of an whatsapp number.

Example URI

GET https://rest.setrow.com/whatsapp/905448848919
Response  Success
HideShow
Body
Response  Error
HideShow

Get Whatsapp Number Report
GET /whatsapp/report?{parameters}

It's a Setrow API feature to get the lists of whatsapp sending reports.

Example URI

GET https://rest.setrow.com/whatsapp/report?reportType=1&number=905448848919&startDate=2022-01-05&lastDate=2022-01-15
Parameters
HideShow
Response  Success
HideShow
Body
Response  Error
HideShow

Whatsapp Number Add/Update
POST /whatsapp/add

It's a Setrow API feature to add or update an sms number. If there is no record with this whatsapp number, it adds it, if it does, it updates it. With a single request, you can perform bulk transactions with a maximum of 1000 whatsapp numbers.

Example URI

POST https://rest.setrow.com/whatsapp/add
Parameters
HideShow
See all IYS values
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Whatsapp Number Delete
DELETE /whatsapp/delete

It is a Setrow API feature for deleting an sms number from any groups. With a single request, you can perform bulk transactions with a maximum of 1000 whatsapp numbers.

Example URI

DELETE https://rest.setrow.com/whatsapp/delete
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Get Wrong Whatsapp List
GET /wrong/whatsapp/list/?{parameters}

It's a Setrow API feature to get the list of wrong whatsapp numbers.

Example URI

GET https://rest.setrow.com/wrong/whatsapp/list/?startDate=2022-01-10&lastDate=2022-01-20
Parameters
HideShow
Response  Success
HideShow
Body
Response  Error
HideShow

Get Wrong Whatsapp List
GET /wrong/whatsapp/list/?{parameters}

It's a Setrow API feature to get the list of wrong whatsapp numbers.

Example URI

GET https://rest.setrow.com/wrong/whatsapp/list/?startDate=2022-01-10&lastDate=2022-01-20
Parameters
HideShow
Response  Success
HideShow
Body
Response  Error
HideShow

Get Whatsapp Groups
GET /group/whatsapp

It's a Setrow API feature to get list of whatsapp groups.

Example URI

GET https://rest.setrow.com/group/whatsapp
Response  Success
HideShow
Body

Get Whatsapp Group Data
GET /group/whatsapp/{whatsapp_group_id}

It's a Setrow API feature to get list of users registered to a whatsapp group.

Example URI

GET https://rest.setrow.com/group/whatsapp/123456
Response  Success
HideShow
Body

Create Whatsapp Group
POST /group/whatsapp

It's a Setrow API feature to create whatsapp group.

Example URI

POST https://rest.setrow.com/group/whatsapp
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Whatsapp Unsubscribe List
GET /unsubscribe/whatsapp/list/?{parameters}

It's a Setrow API feature to get the list of unsubscriber whatsapp numbers.

Example URI

GET https://rest.setrow.com/unsubscribe/whatsapp/list/?startDate=2022-01-01&lastDate=2022-01-20
Response  Success
HideShow
Body
Response  Error
HideShow

Whatsapp Unsubscribe Status
GET /unsubscribe/whatsapp

It's a Setrow API feature to get whatsapp number unsubscribe status.

Example URI

GET https://rest.setrow.com/unsubscribe/whatsapp/905555555555
Response  Success
HideShow
Body

Add Whatsapp Number
POST /unsubscribe/whatsapp

It's a Setrow API feature add the whatsapp number to unsubscribe list.

Example URI

POST https://rest.setrow.com/unsubscribe/whatsapp
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Delete Whatsapp Number
DELETE /unsubscribe/whatsapp

It's a Setrow API feature add the whatsapp number to unsubscribe list.

Example URI

DELETE https://rest.setrow.com/unsubscribe/whatsapp
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Group Operations

Email Group Operations

Get manual Groups
GET /group/email

It's a Setrow API feature to get list of email groups.

Example URI

GET https://rest.setrow.com/group/email
Response  Success
HideShow
Body

Get manual Group Data
GET /group/email/{group_id}

It's a Setrow API feature to get list of users registered to a email group.

Example URI

GET https://rest.setrow.com/group/email/123456
Response  Success
HideShow
Body

Get manual Group Data with Filter/Filters
GET /group/email/{group_id}?{parameters}

It's a Setrow API feature to get list of users registered to a email group by filter.

Example URI

GET https://rest.setrow.com/group/email/123456?_filter=spArea1:Y&getAreas=spArea1,spArea2&updateDateArea=spArea3&lastUpdateDate=2022-02-06 22:36:48
Parameters
HideShow
Response  Success
HideShow
Body

Get Auto Group Data
GET /group/email/auto/{group_id}

It's a Setrow API feature to get list of users registered to a auto group.

Example URI

GET https://rest.setrow.com/group/email/auto/{group_id}
Response  Success
HideShow
Body

Create manual Group
POST /group/email

It's a Setrow API feature to create email group.

Example URI

POST https://rest.setrow.com/group/email
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Sms Group Operations

Get SMS Groups
GET /group/sms

It's a Setrow API feature to get list of sms groups.

Example URI

GET https://rest.setrow.com/group/sms
Response  Success
HideShow
Body

Get SMS Group Data
GET /group/sms/{sms_group_id}

It's a Setrow API feature to get list of users registered to a sms group.

Example URI

GET https://rest.setrow.com/group/sms/123456
Response  Success
HideShow
Body

Get SMS Group Data with Filter/Filters
GET /group/sms/{sms_group_id}?{parameters}

It's a Setrow API feature to get list of users registered to a sms group by filter.

Example URI

GET https://rest.setrow.com/group/sms/123456?_filters=spArea2=HS_WEB,spArea1=Y&getAreas=spArea1,spArea2,spArea3
Parameters
HideShow
Response  Success
HideShow
Body

Create SMS Group
POST /group/sms

It's a Setrow API feature to create sms group.

Example URI

POST https://rest.setrow.com/group/sms
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Category Operations

Get All Categories
GET /category

It's a Setrow API feature to get the list of all categories.

Example URI

GET https://rest.setrow.com/category
Response  Success
HideShow
Body

Add Category
POST /category/add

It's a Setrow API feature to add or update an category. If there is no record with this category id, it adds it, if it does, it updates it. With a single request, you can perform bulk transactions with a maximum of 1000 categories.

Example URI

POST https://rest.setrow.com/category/add
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Delete Category
DELETE /category/delete/{categoryId}

It's a Setrow API feature to delete the category.

Example URI

DELETE https://rest.setrow.com/category/delete/2345
Response  Success
HideShow
Body
Response  Error
HideShow

Product Operations

Get All Products
GET /product/all/{status}

It's a Setrow API feature to get the list of all products. Status: 1>Active , 2>Passive

Example URI

GET https://rest.setrow.com/product/all/1
Response  Success
HideShow
Body

Get Products By Code
GET /product/code/{productCode}

It's a Setrow API feature to get the product by product code.

Example URI

GET https://rest.setrow.com/product/code/STRW-01
Response  Success
HideShow
Body
Response  Error
HideShow

Get Products By Barcode
GET /product/barcode/{barcode}

It's a Setrow API feature to get the product by product barcode.

Example URI

GET https://rest.setrow.com/product/barcode/12345678
Response  Success
HideShow
Body
Response  Error
HideShow

Product Add/Update
POST /product/add

It's a Setrow API feature to add or update a product.

Example URI

POST https://rest.setrow.com/product/add
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Delete Product By Code
DELETE /product/delete/code/{productCode}

It's a Setrow API feature to delete a product by product code.

Example URI

DELETE https://rest.setrow.com/product/delete/code/STRW-01
Response  Success
HideShow
Body
Response  Error
HideShow

Delete Product By Barcode
DELETE /product/delete/barcode/{barcode}

It's a Setrow API feature to delete a product by product barcode.

Example URI

DELETE https://rest.setrow.com/product/delete/barcode/12345678
Response  Success
HideShow
Body
Response  Error
HideShow

Favorite Operations

Get All Favorites
GET /favorite/{email}

It's a Setrow API feature to get the list of favorite products of an email.

Example URI

GET https://rest.setrow.com/favorite/test@setrow.com
Response  Success
HideShow
Body

Add Favorites
POST /favorite

It's a Setrow API feature to add a product to favorites. With a single request, you can perform bulk transactions with a maximum of 1000 categories.

Example URI

POST https://rest.setrow.com/favorite
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Delete favorites
DELETE /favorite

It's a Setrow API feature to delete the product from favorites.

Example URI

DELETE https://rest.setrow.com/favorite
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Basket Operations

Get Baskets
GET /baskets/{email}

It's a Setrow API feature to get the list of baskets of an email.

Example URI

GET https://rest.setrow.com/baskets/test@setrow.com
Response  Success
HideShow
Body

Add Basket
POST /baskets

It's a Setrow API feature to add a product to basket. With a single request, you can perform bulk transactions with a maximum of 1000 baskets.

Example URI

POST https://rest.setrow.com/baskets
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body

Delete Basket
DELETE /baskets

It's a Setrow API feature to delete the product from basket.

Example URI

DELETE https://rest.setrow.com/baskets
Example Request
HideShow
Body
Response  Success
HideShow
Body

Order Operations

Get Orders
GET /orders/{email}

It's a Setrow API feature to get the list of orders of an email.

Example URI

GET https://rest.setrow.com/orders/test@setrow.com
Response  Success
HideShow
Body

Add Order
POST /orders/add

It's a Setrow API feature to add an order. With a single request, you can perform bulk transactions with a maximum of 1000 orders.

Example URI

POST https://rest.setrow.com/orders/add
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Update Order Status
POST /orders/updateStatus

It's a Setrow API feature to update an order status. With a single request, you can perform bulk transactions with a maximum of 1000 orders.

Example URI

POST https://rest.setrow.com/orders/updateStatus
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Delete Order
DELETE /orders/delete

It's a Setrow API feature to delete an order. With a single request, you can perform bulk transactions with a maximum of 1000 orders.

Example URI

DELETE https://rest.setrow.com/orders/delete
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Unsubscribe Operations

Email Unsubscribe Operations

Email Unsubscribe List
GET /unsubscribe/email/list/?{parameters}

It's a Setrow API feature to get the list of unsubscriber emails.

Example URI

GET https://rest.setrow.com/unsubscribe/email/list/?startDate=2022-01-01&lastDate=2022-01-20
Response  Success
HideShow
Body
Response  Error
HideShow

Add Email Address
POST /unsubscribe/email

It's a Setrow API feature add the email address to unsubscribe list.

Example URI

POST https://rest.setrow.com/unsubscribe/email
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Delete Email Address
DELETE /unsubscribe/email

It's a Setrow API feature add the email address to unsubscribe list.

Example URI

DELETE https://rest.setrow.com/unsubscribe/email
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Email Unsubscribe Status
GET /unsubscribe/email

It's a Setrow API feature to get email unsubscribe status.

Example URI

GET https://rest.setrow.com/unsubscribe/email/test@setrow.com
Response  Success
HideShow
Body

SMS Unsubscribe Operations

Sms Unsubscribe List
GET /unsubscribe/sms/list/?{parameters}

It's a Setrow API feature to get the list of unsubscriber sms numbers.

Example URI

GET https://rest.setrow.com/unsubscribe/sms/list/?startDate=2022-01-01&lastDate=2022-01-20
Response  Success
HideShow
Body
Response  Error
HideShow

Add Sms Number
POST /unsubscribe/sms

It's a Setrow API feature add the sms number to unsubscribe list.

Example URI

POST https://rest.setrow.com/unsubscribe/sms
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

Delete Sms Number
DELETE /unsubscribe/sms

It's a Setrow API feature add the sms number to unsubscribe list.

Example URI

DELETE https://rest.setrow.com/unsubscribe/sms
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

SMS Unsubscribe Status
GET /unsubscribe/sms

It's a Setrow API feature to get sms number unsubscribe status.

Example URI

GET https://rest.setrow.com/unsubscribe/sms/5555555555
Response  Success
HideShow
Body

Junk Address Operations

Get Junk List
GET /junk/list/?{parameters}

It's a Setrow API feature to get the list of junk emails.

Example URI

GET https://rest.setrow.com/junk/list/?startDate=2022-01-10&lastDate=2022-01-20
Parameters
HideShow
Response  Success
HideShow
Body
Response  Error
HideShow

Get Junk Status
GET /junk

It's a Setrow API feature to get the junk status of an email.

Example URI

GET https://rest.setrow.com/junk/test@setrow.com
Response  Success
HideShow
Body

Wrong Address Operations

Get Wrong Address List
GET /wrong/list/?{parameters}

It's a Setrow API feature to get the list of wrong emails.

Example URI

GET https://rest.setrow.com/wrong/list/?startDate=2022-01-10&lastDate=2022-01-20
Parameters
HideShow
Response  Success
HideShow
Body
Response  Error
HideShow

IYS Operations

IYS Get Errors
GET /iys/errors/{hours}

It's a Setrow API feature to get the list of IYS send errors.

Example URI

GET https://rest.setrow.com/iys/errors/24
Response  Success
HideShow
Body
Response  Error
HideShow

IYS Get Successes
GET /iys/successes/{hours}

It's a Setrow API feature to get the list of successful IYS sends.

Example URI

GET https://rest.setrow.com/iys/successes/24
Response  Success
HideShow
Body
Response  Error
HideShow

IYS Get Email Group Data
GET /iys/list/email?{parameters}

It's a Setrow API feature to get the list of an IYS email group members with date filter.

Example URI

GET https://rest.setrow.com/iys/list/email?hour=24&groupId=123456&consentDateArea=spArea1&getAreas=spArea3,spArea5
Parameters
HideShow
Response  Success
HideShow
Body
Response  Error
HideShow

IYS Get Sms Group Data
GET /iys/list/sms?{parameters}

It's a Setrow API feature to get the list of an IYS sms group members with date filter.

Example URI

GET https://rest.setrow.com/iys/list/sms?hour=24&groupId=123456&consentDateArea=spArea1&getAreas=spArea3,spArea5
Parameters
HideShow
Response  Success
HideShow
Body
Response  Error
HideShow

IYS TransactionID Save
POST /iys/transaction

After sending data to the IYS system using this API, you can store the requestid and the transaction id information in the requestid block for gsm numbers and email addresses. This way, you can have the IYS data transmission history reported and archived in the panel. To access the relevant records, you should check on the contact cards using the e-mail address or number. By default, an SMS account must be set up on the Setrow panel for GSM numbers.

Example URI

POST https://rest.setrow.com/iys/transaction
Parameters
HideShow
Example Request
HideShow
Body
Response  Success
HideShow
Body
Response  Error
HideShow

IYS Values

List of IYS OPT-IN source values.

Value Meaning
1 HS_FIZIKSELORTAM
2 HS_ISLAKIMZA
3 HS_WEB
4 HS_CAGRIMERKEZI
5 HS_SOSYALMEDYA
6 HS_MOBIL
7 HS_EORTAM
8 HS_ETKINLIK
9 HS_2015
10 HS_ATM
11 HS_KARAR
12 IYS_3338
13 IYS_CM
14 IYS_WEB
15 IYS_MOBIL
16 IYS_KISA_LINK

List of IYS OPT-OUT source values.

Value Meaning
1 HS_EPOSTA
2 HS_MESAJ
3 HS_WEB
4 HS_MOBIL
5 HS_KARAR
6 HS_CAGRIMERKEZI
7 HS_EORTAM
8 HS_SOSYALMEDYA
9 HS_ATM
10 IYS_3338
11 IYS_CM
12 IYS_WEB
13 IYS_MOBIL
14 IYS_KISA_LINK

Allow status values.

Value Meaning
Y Allowed
N Not allowed
L Legaly allowed
X Changed from allowed to not allowed (Unsubscriber)

Error Codes

List of error codes and error messages returned in response to API requests.

Error Code Error Description
E100 A required parameter is not defined.
E101 An error occurred during an operation.
E102 A required info is no set.
E103 A parameter is not valid.
E104 Email address not registered in Setrow Databases.
E105 You are not authorized for this group.
E106 The entered auto group was not found.
E107 Parameter must be longer than minimum character length limit.
E108 Mini-plan customers can have a maximum of 10 manual groups.
E109 Group name has already been used.
E110 Sms settings not found.
E111 There is no member with this address.
E112 There is no product with this product_code.
E113 There is no group with this group_id.
E114 This product has already been added to favorites.
E115 This e-mail address is already registered in the list.
E116 This e-mail address is not registered in the list.
E117 This number is already registered in the list.
E118 This number is not registered in the list.
E119 This number not registered in Setrow Databases.
E120 This email address not registered in User Databases.
E121 This number not registered in User Databases.
E122 lastDate parameter must be greater than startDate parameter.
E123 The difference between the startDate parameter and the lastDate parameter can be up to 30 days.
E124 Request is not valid, please check API information.
E125 Request is too long, max available length 1000.
E126 This email address is registered in the list of those who do not want email. The operation cannot be performed.
E127 This email address is registered in the list of wrong addresses. The operation cannot be performed.
E128 This email address is registered in the list of junk addresses. The operation cannot be performed.
E129 This phone number is registered in the list of those who do not want sms. The operation cannot be performed.
E130 This number is not registered in the Setrow databases.
E131 This number is not registered in this group.
E132 This email address is not registered in this group.
E133 At least one of the Number or Date filters must be used.
E134 A numeric value must be entered.
E135 Value cannot be greater than 96.
E136 hour parameter cannot be greater than 96.
E137 productBarcode or productCode parameter must set.
E138 This barcode is defined for another product code.
E139 The product could not be updated. Current data is already up to date.
E140 The product not found in Setrow Databases.
E141 The category not found in Setrow Databases.
E142 categoryId and parentCategoryId are equal.
E143 This product has already been deleted from favorites.
E144 This order not found in Setrow Databases.
E145 Account inactive.
E146 The account does not have an IYS data transfer pool, please notify the e-mail address of yazilim@setrow.com.
E401 User auth failed.
E403 IP address not allowed, please contact destek@setrow.com
E404 The server can not find the requested resource.

Setrow