GET /api/v3/mail-template
Request parameter:
No Request parameter
Filtering parameters:
| Parameter | Type | IN | Example | Description |
|---|---|---|---|---|
| language | int | QUERY | filters[language]=1 | Id of API: Language |
| name | string | QUERY | filters[name]=welcome | Full name of a template (does not use wildcards) |
/wiki/spaces/BROK/pages/693181 #List defaults
Response data:
Metadata: object.
| Parameter | Type | Description |
|---|---|---|
| count | int | Number of all results matching criteria |
| status | int | Response status (same as in http code) |
Data: object.data[array]
| Parameter | Type | Description |
|---|---|---|
| id | integer | Contact id |
| name | string | Contact name (virtual field) - made from name_1 and name_2 |
| language | array | Template API: Language |
| language[id] | int|null | Language id |
| language[locale] | string(2) | Language locale |
| language[name] | string | Language name in language DE |
| language[name_e] | string|null | Language name in language EN |
| language[name_i] | string|null | Language name in language IT |
| language[name_f] | string|null | Language name in language FR |
Response (Error):
| Parameter | Type | Description |
|---|---|---|
| code | integer | An error code |
| error | string | A message containing some information about the error |
| errors | array | List of errors devided by field in associative array {field_name:error message} |
/wiki/spaces/BROK/pages/693181 #Authentication defaults
Request
curl -X GET https://public.brokerstar.biz/api/v3/mail-template --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK
{
"count": "2",
"data": [
{
"language": {
"name_e": "German",
"name_f": "allemand",
"name_i": "tedesco",
"id": 1,
"locale": "de",
"name": "Deutsch"
},
"id": 1,
"name": "for mailing"
},
[...]
],
"status": 200
}
Or one of
- /wiki/spaces/BROK/pages/693181 #Authentication defaults
- /wiki/spaces/BROK/pages/693181 #List defaults