EDB Postgres Enterprise Manager REST APIs v13.0: Email Groups v10.2

get__email_groups

Code samples

GET /email/groups

Retrieve the email groups list.

Parameters

NameInTypeRequiredDescription
X-Auth-TokenheaderstringtrueToken of authorization

Example responses

200 Response
[
  {
    "id": 0,
    "oid": 0,
    "gid": 0,
    "name": "string",
    "to_addr": "string",
    "cc_addr": "string",
    "bcc_addr": "string",
    "from_addr": "string",
    "reply_to_addr": "string",
    "subject_prefix": "string",
    "from_time": "00:00:00",
    "to_time": "23:59:59"
  }
]

Responses

StatusMeaningDescriptionSchema
200OKStatus 200Inline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[EmailGroups]falsenonenone
» idintegerfalsenoneEmail group ID
» oidintegerfalsenoneEmail group options ID
» gidintegerfalsenoneEmail group ID
» namestringfalsenoneEmail group name
» to_addrstringfalsenoneEmail group options receiver address
» cc_addrstringfalsenoneEmail group options CC address
» bcc_addrstringfalsenoneEmail group options BCC address
» from_addrstringfalsenoneEmail group options sender address
» reply_to_addrstringfalsenoneEmail group options reply to address
» subject_prefixstringfalsenoneEmail group options subject prefix
» from_timestringfalsenoneEmail group options from time to select time range for members
» to_timestringfalsenoneEmail group options to time to select time range for members
Info

This operation does not require authentication

post__email_groups

Code samples

POST /email/groups

Add a new email group.

Body parameter

{
  "name": "string",
  "options": [
    {
      "to_addr": "string",
      "cc_addr": "string",
      "bcc_addr": "string",
      "from_addr": "string",
      "reply_to_addr": "string",
      "subject_prefix": "string",
      "from_time": "00:00:00",
      "to_time": "23:59:59"
    }
  ]
}

Parameters

NameInTypeRequiredDescription
X-Auth-TokenheaderstringtrueToken of authorization
bodybodyEmailGroupsPostDatatruenone

Example responses

Responses

StatusMeaningDescriptionSchema
200OKEmail group created successfullyNone

Response Schema

Info

This operation does not require authentication

get__email_groups_{email_group_id}

Code samples

GET /email/groups/{email_group_id}

Retrieve information for the email group, identified by the email_group_id.

Parameters

NameInTypeRequiredDescription
email_group_idpathstringtruenone
X-Auth-TokenheaderstringtrueToken of authorization

Example responses

200 Response
{
  "id": 0,
  "oid": 0,
  "gid": 0,
  "name": "string",
  "to_addr": "string",
  "cc_addr": "string",
  "bcc_addr": "string",
  "from_addr": "string",
  "reply_to_addr": "string",
  "subject_prefix": "string",
  "from_time": "00:00:00",
  "to_time": "23:59:59"
}

Responses

StatusMeaningDescriptionSchema
200OKStatus 200EmailGroups
Info

This operation does not require authentication

put__email_groups_{email_group_id}

Code samples

PUT /email/groups/{email_group_id}

Update the email group information.

Body parameter

{
  "name": "string",
  "options": {
    "added": [
      {
        "to_addr": "string",
        "cc_addr": "string",
        "bcc_addr": "string",
        "from_addr": "string",
        "reply_to_addr": "string",
        "subject_prefix": "string",
        "from_time": "00:00:00",
        "to_time": "23:59:59"
      }
    ],
    "changed": [
      {
        "oid": 0,
        "to_addr": "string",
        "cc_addr": "string",
        "bcc_addr": "string",
        "from_addr": "string",
        "reply_to_addr": "string",
        "subject_prefix": "string",
        "from_time": "00:00:00",
        "to_time": "23:59:59"
      }
    ],
    "deleted": [
      {
        "oid": 0
      }
    ]
  }
}

Parameters

NameInTypeRequiredDescription
email_group_idpathstringtruenone
X-Auth-TokenheaderstringtrueToken of authorization
bodybodyEmailGroupsPutDatatruenone

Example responses

Responses

StatusMeaningDescriptionSchema
200OKExcluded databases added successfullyNone

Response Schema

Info

This operation does not require authentication

delete__email_groups_{email_group_id}

Code samples

DELETE /email/groups/{email_group_id}

Delete the email group.

Parameters

NameInTypeRequiredDescription
email_group_idpathstringtruenone
X-Auth-TokenheaderstringtrueToken of authorization

Example responses

Responses

StatusMeaningDescriptionSchema
200OKEmail group deleted successfullyNone

Response Schema

Info

This operation does not require authentication