[lightMode]
Export Customers
POST
/exports/customers[updatedIn] 23 days ago
This endpoint allows you to export customers
Request
[message.bodyParameter]application/json
type
enum<string>
required
you can either request the exported file by entering customers
of a sample file using customers-sample
Allowed values:
customerscustomers-sample
[api.label.example]
{
"type": "customers"
}
Request samples
[api.label.responses]
Success | customers(200)
Success | customers-sample(200)
Success | customers
HTTP Code: 200
Content Type : JSONapplication/json
[response.label.jsonSchema]
status
integer
required
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition
success
boolean
required
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
data
object
required
message
string
required
The exported file will be sent to the email address
[api.label.example]
{
"status": 200,
"success": true,
"data": {
"message": "سوف يتم ارسال بيانات العملاء علي بريدك الالكتروني بعد قليل"
}
}
[updatedIn] 23 days ago