Skip to content

Create an organization email account

POST
/api/settings/email-accounts
curl --request POST \
--url https://api.getvespy.com/api/settings/email-accounts \
--header 'Authorization: Bearer <token>'

Default Response

Media typeapplication/json
object
account
required
object
createdAt
required
string format: date-time
displayName
required
string
nullable
emailAddress
required
string format: email
enabled
required
boolean
id
required
string format: uuid
isDefault
required
boolean
organizationId
required
string format: uuid
provider
required
string
Allowed values: system gmail outlook imap
updatedAt
required
string format: date-time
verified
required
boolean
Example
{
"account": {
"provider": "system"
}
}

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
"code": "example",
"errors": [
{
"code": "example",
"message": "example",
"path": "example"
}
],
"message": "example"
}

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
"code": "example",
"errors": [
{
"code": "example",
"message": "example",
"path": "example"
}
],
"message": "example"
}

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
"code": "example",
"errors": [
{
"code": "example",
"message": "example",
"path": "example"
}
],
"message": "example"
}