API: Mail Templates

Owned by Maciej Szewczyk
Last updated: Okt. 10, 2024
2 min read

Template list

JWT Authorisation

GET /api/v3/mail-template

Request parameter:

No Request parameter

Filtering parameters:

ParameterTypeINExampleDescription
languageintQUERYfilters[language]=1Id of API: Language
namestringQUERYfilters[name]=welcomeFull name of a template (does not use wildcards)


/wiki/spaces/BROK/pages/693181 #List defaults

Response data:

Metadata: object.

ParameterTypeDescription
countintNumber of all results matching criteria 
statusintResponse status (same as in http code)

Data:  object.data[array]

ParameterTypeDescription
idintegerContact id
namestringContact name (virtual field) - made from name_1 and name_2 
languagearrayTemplate API: Language
language[id]int|nullLanguage id
language[locale]string(2)Language locale
language[name]stringLanguage name in language DE
language[name_e]string|nullLanguage name in language EN
language[name_i]string|nullLanguage name in language IT
language[name_f]string|nullLanguage name in language FR

Response (Error):

ParameterTypeDescription
codeintegerAn error code
errorstringA message containing some information about the error 
errorsarrayList of errors devided by field in associative array {field_name:error message}

API: _ Default behavior#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