Add SMTP Email provider

POST 
/email/smtp

Add a new SMTP Email provider if nothing is set yet.

Request

application/json

Body

required

senderAddress stringrequired

Possible values: non-empty and <= 200 characters

senderName stringrequired

Possible values: non-empty and <= 200 characters

tls boolean
host stringrequired

Possible values: non-empty and <= 500 characters

Make sure to include the port.

user string
password string
replyToAddress string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

application/grpc

Body

required

senderAddress stringrequired

Possible values: non-empty and <= 200 characters

senderName stringrequired

Possible values: non-empty and <= 200 characters

tls boolean
host stringrequired

Possible values: non-empty and <= 500 characters

Make sure to include the port.

user string
password string
replyToAddress string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

application/grpc-web+proto

Body

required

senderAddress stringrequired

Possible values: non-empty and <= 200 characters

senderName stringrequired

Possible values: non-empty and <= 200 characters

tls boolean
host stringrequired

Possible values: non-empty and <= 500 characters

Make sure to include the port.

user string
password string
replyToAddress string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

Responses

200

A successful response.

application/json

Schema

Schema

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-21T14:48:14.511Z",
    "changeDate": "2024-11-21T14:48:14.511Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

application/grpc

Schema

Schema

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-21T14:48:14.511Z",
    "changeDate": "2024-11-21T14:48:14.511Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

application/grpc-web+proto

Schema

Schema

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-21T14:48:14.511Z",
    "changeDate": "2024-11-21T14:48:14.511Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...