E-Mail API specification (3.1.4)

Download OpenAPI specification:Download

The e-mail service implements all e-mail functions for GroupAlarm

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type API Key
Header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type API Key
Header parameter name: Personal-Access-Token

email

List

Returns all configured alarm-notification email adresses of an user

query Parameters
owner_id
required
int64

ID of an user

organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

all email adresses of the requested user

400

owner id is missing or in a wrong format

500

Unexpected database error

get /
https://app.groupalarm.com/api/v1/email/

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create

Creates an email configuration

query Parameters
organization_id
int64

requesting organization, not required if user accesses his own resources

Request Body schema: application/json

email configuration payload

active
boolean

defines, if this email is active for alarm notifications

email
string

email address

id
integer <int64>

id of this email

name
string

user defined name for this address (e.g. private)

ownerID
integer <int64>

assinged user id for this email

Responses

200

created email configuration

400

email payload is missing or in a wrong format

500

Unexpected database error

post /
https://app.groupalarm.com/api/v1/email/

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Get

Creates an email configuration

path Parameters
emailID
required
int64

ID of an email configuration

query Parameters
organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

requested email configuration

400

email payload is missing or in a wrong format

500

Unexpected database error

get /{emailID}
https://app.groupalarm.com/api/v1/email/{emailID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Update

Updates an email configuration

path Parameters
emailID
required
int64

ID of an email configuration

query Parameters
organization_id
int64

requesting organization, not required if user accesses his own resources

Request Body schema: application/json

email configuration payload

active
boolean

defines, if this email is active for alarm notifications

email
string

email address

id
integer <int64>

id of this email

name
string

user defined name for this address (e.g. private)

ownerID
integer <int64>

assinged user id for this email

Responses

200

updated email configuration

400

email payload is missing or in a wrong format

500

Unexpected database error

put /{emailID}
https://app.groupalarm.com/api/v1/email/{emailID}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Delete

Deletes an email configuration

path Parameters
emailID
required
int64

ID of an email configuration

query Parameters
organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

response message

400

email payload is missing or in a wrong format

500

Unexpected database error

delete /{emailID}
https://app.groupalarm.com/api/v1/email/{emailID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "status": "deleted"
}

organizations

GetDisabledOrganization

Returns whether the given organization has disabled this way of alarming or not

query Parameters
organization_id
required
int64

requesting organization

Responses

200

whether this way of alarming is disabled or not

400

organization_id is missing or in wrong format

500

Unexpected database error

get /disabled
https://app.groupalarm.com/api/v1/email/disabled

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

SetDisabledOrganization

Sets whether the given organization has this way of alarming disabled or not

query Parameters
organization_id
required
int64

requesting organization

Request Body schema: application/json

isDisabled payload

isDisabled
boolean

Responses

200

request successful

400

organization_id is missing or in wrong format

500

Unexpected database error

put /disabled
https://app.groupalarm.com/api/v1/email/disabled

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "isDisabled": true
}

email-settings

GetSettings

Gets the configured organization email settings

path Parameters
organizationID
required
int64

Responses

200

configured organization email settings

400

Passed organization id is not valid

404

The settings for this organization are not defined yet

500

Unexpected database error

get /settings/{organizationID}
https://app.groupalarm.com/api/v1/email/settings/{organizationID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "backgroundColor": "string",
  • "footerText": "string"
}

UpsertSettings

Creates or updates the email settings for the passed organization

path Parameters
organizationID
required
int64
Request Body schema: application/json
backgroundColor
string
footerText
string

Responses

200

the settings are saved successfully

400

Passed settings payload is in the wrong format

500

Unexpected database error

post /settings/{organizationID}
https://app.groupalarm.com/api/v1/email/settings/{organizationID}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "backgroundColor": "string",
  • "footerText": "string"
}