PATCH /company/companies/@id/recurrent-emails/@recurrent_email_id
This endpoint requires authentication.
| Header | Value |
|---|---|
| Authorization | Set the value to Bearer + + access_token |
Replace the @ keywords in the URL with their corresponding value.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| id | Int | The ID of the company |
| recurrent_email_id | Int | The ID of the recurrent email |
Pass the following properties via application/json or form encoding in the body of the request.
| Field | Type | Description |
|---|---|---|
| type | String | String enumarion of 'company-emails', 'delivery-list' |
| shop_ids | [Int] | Shop ids this recurrent email applies to |
| send_to | [Email] | Send emails to these email addresses |
| send_at | Dictionary | A dictionary with fields |
| timezone | String | String enumarion of 'Europe/Brussels', 'Europe/Amsterdam', 'Europe/Madrid', 'Europe/Paris', 'Europe/Berlin', 'Europe/London', 'Europe/Rome', 'Europe/Lisbon', 'Europe/Athens', 'Europe/Busingen', 'Europe/Zurich', 'Europe/Stockholm', 'Europe/Bucharest', 'Europe/Warsaw', 'Europe/Budapest', 'Europe/Chisinau', 'Atlantic/Canary', 'Atlantic/Azores', 'Atlantic/Madeira', 'Europe/Luxembourg', 'Europe/Vienna', 'America/Adak', 'America/Anchorage', 'America/Boise', 'America/Chicago', 'America/Denver', 'America/Detroit', 'America/Indiana/Indianapolis', 'America/Indiana/Knox', 'America/Indiana/Marengo', 'America/Indiana/Petersburg', 'America/Indiana/Tell_City', 'America/Indiana/Vevay', 'America/Indiana/Vincennes', 'America/Indiana/Winamac', 'America/Juneau', 'America/Kentucky/Louisville', 'America/Kentucky/Monticello', 'America/Los_Angeles', 'America/Menominee', 'America/Metlakatla', 'America/New_York', 'America/Nome', 'America/North_Dakota/Beulah', 'America/North_Dakota/Center', 'America/North_Dakota/New_Salem', 'America/Phoenix', 'America/Sitka', 'America/Yakutat', 'Pacific/Honolulu', 'Asia/Kuala_Lumpur', 'Asia/Kuching', 'America/Argentina/Buenos_Aires', 'America/Argentina/Catamarca', 'America/Argentina/Cordoba', 'America/Argentina/Jujuy', 'America/Argentina/La_Rioja', 'America/Argentina/Mendoza', 'America/Argentina/Rio_Gallegos', 'America/Argentina/Salta', 'America/Argentina/San_Juan', 'America/Argentina/San_Luis', 'America/Argentina/Tucuman', 'America/Argentina/Ushuaia', 'America/Atikokan', 'America/Blanc-Sablon', 'America/Cambridge_Bay', 'America/Creston', 'America/Dawson', 'America/Dawson_Creek', 'America/Edmonton', 'America/Fort_Nelson', 'America/Glace_Bay', 'America/Goose_Bay', 'America/Halifax', 'America/Inuvik', 'America/Iqaluit', 'America/Moncton', 'America/Nipigon', 'America/Pangnirtung', 'America/Rainy_River', 'America/Rankin_Inlet', 'America/Regina', 'America/Resolute', 'America/St_Johns', 'America/Swift_Current', 'America/Thunder_Bay', 'America/Toronto', 'America/Vancouver', 'America/Whitehorse', 'America/Winnipeg', 'America/Yellowknife', 'America/Sao_Paulo', 'America/Araguaina', 'America/Bahia', 'America/Belem', 'America/Boa_Vista', 'America/Campo_Grande', 'America/Cuiaba', 'America/Eirunepe', 'America/Fortaleza', 'America/Maceio', 'America/Manaus', 'America/Noronha', 'America/Porto_Velho', 'America/Recife', 'America/Rio_Branco', 'America/Santarem', 'America/Bahia_Banderas', 'America/Cancun', 'America/Chihuahua', 'America/Hermosillo', 'America/Matamoros', 'America/Mazatlan', 'America/Merida', 'America/Mexico_City', 'America/Monterrey', 'America/Ojinaga', 'America/Tijuana', 'America/Costa_Rica', 'America/Santiago', 'Asia/Manila', 'UTC' |
| company_emails | Dictionary | When using type "company-emails", select which emails should be sent or not |
PATCH /company/companies/14/recurrent-emails/18 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 831
{
"type": "company-emails",
"shop_ids": [
11,
18,
10
],
"send_to": [
"example@domain.com",
"example@domain.com",
"example@domain.com"
],
"send_at": {
"d1": {
"at": "12:00"
},
"d2": {
"at": "12:00"
},
"d3": {
"at": "12:00"
},
"d4": {
"at": "12:00"
},
"d5": {
"at": "12:00"
},
"d6": {
"at": "12:00"
},
"d7": {
"at": "12:00"
}
},
"timezone": "Europe/Brussels",
"company_emails": {
"daily_order_list": false,
"daily_production_list": false,
"new_order": true,
"cancel_order": true,
"comment_on_order": false
}
}| Field | Type | Description |
|---|---|---|
| type | String | String enumarion of 'company-emails', 'delivery-list' |
| shop_ids | [Int] | Shop ids this recurrent email applies to |
| send_to | [Email] | Send emails to these email addresses |
| send_at | Dictionary | A dictionary with fields |
| timezone | String | String enumarion of 'Europe/Brussels', 'Europe/Amsterdam', 'Europe/Madrid', 'Europe/Paris', 'Europe/Berlin', 'Europe/London', 'Europe/Rome', 'Europe/Lisbon', 'Europe/Athens', 'Europe/Busingen', 'Europe/Zurich', 'Europe/Stockholm', 'Europe/Bucharest', 'Europe/Warsaw', 'Europe/Budapest', 'Europe/Chisinau', 'Atlantic/Canary', 'Atlantic/Azores', 'Atlantic/Madeira', 'Europe/Luxembourg', 'Europe/Vienna', 'America/Adak', 'America/Anchorage', 'America/Boise', 'America/Chicago', 'America/Denver', 'America/Detroit', 'America/Indiana/Indianapolis', 'America/Indiana/Knox', 'America/Indiana/Marengo', 'America/Indiana/Petersburg', 'America/Indiana/Tell_City', 'America/Indiana/Vevay', 'America/Indiana/Vincennes', 'America/Indiana/Winamac', 'America/Juneau', 'America/Kentucky/Louisville', 'America/Kentucky/Monticello', 'America/Los_Angeles', 'America/Menominee', 'America/Metlakatla', 'America/New_York', 'America/Nome', 'America/North_Dakota/Beulah', 'America/North_Dakota/Center', 'America/North_Dakota/New_Salem', 'America/Phoenix', 'America/Sitka', 'America/Yakutat', 'Pacific/Honolulu', 'Asia/Kuala_Lumpur', 'Asia/Kuching', 'America/Argentina/Buenos_Aires', 'America/Argentina/Catamarca', 'America/Argentina/Cordoba', 'America/Argentina/Jujuy', 'America/Argentina/La_Rioja', 'America/Argentina/Mendoza', 'America/Argentina/Rio_Gallegos', 'America/Argentina/Salta', 'America/Argentina/San_Juan', 'America/Argentina/San_Luis', 'America/Argentina/Tucuman', 'America/Argentina/Ushuaia', 'America/Atikokan', 'America/Blanc-Sablon', 'America/Cambridge_Bay', 'America/Creston', 'America/Dawson', 'America/Dawson_Creek', 'America/Edmonton', 'America/Fort_Nelson', 'America/Glace_Bay', 'America/Goose_Bay', 'America/Halifax', 'America/Inuvik', 'America/Iqaluit', 'America/Moncton', 'America/Nipigon', 'America/Pangnirtung', 'America/Rainy_River', 'America/Rankin_Inlet', 'America/Regina', 'America/Resolute', 'America/St_Johns', 'America/Swift_Current', 'America/Thunder_Bay', 'America/Toronto', 'America/Vancouver', 'America/Whitehorse', 'America/Winnipeg', 'America/Yellowknife', 'America/Sao_Paulo', 'America/Araguaina', 'America/Bahia', 'America/Belem', 'America/Boa_Vista', 'America/Campo_Grande', 'America/Cuiaba', 'America/Eirunepe', 'America/Fortaleza', 'America/Maceio', 'America/Manaus', 'America/Noronha', 'America/Porto_Velho', 'America/Recife', 'America/Rio_Branco', 'America/Santarem', 'America/Bahia_Banderas', 'America/Cancun', 'America/Chihuahua', 'America/Hermosillo', 'America/Matamoros', 'America/Mazatlan', 'America/Merida', 'America/Mexico_City', 'America/Monterrey', 'America/Ojinaga', 'America/Tijuana', 'America/Costa_Rica', 'America/Santiago', 'Asia/Manila', 'UTC' |
| company_emails | Dictionary | When using type "company-emails", select which emails should be sent or not |
| id | Int | Id of the recurrent emails entry |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 845
{
"type": "company-emails",
"shop_ids": [
13,
16,
16
],
"send_to": [
"example@domain.com",
"example@domain.com",
"example@domain.com"
],
"send_at": {
"d1": {
"at": "12:00"
},
"d2": {
"at": "12:00"
},
"d3": {
"at": "12:00"
},
"d4": {
"at": "12:00"
},
"d5": {
"at": "12:00"
},
"d6": {
"at": "12:00"
},
"d7": {
"at": "12:00"
}
},
"timezone": "Europe/Brussels",
"company_emails": {
"daily_order_list": false,
"daily_production_list": false,
"new_order": true,
"cancel_order": true,
"comment_on_order": false
},
"id": 19
}