Skip to content
Vespy API

Preview a custom notification blast

POST
/api/notifications/blasts/preview
curl --request POST \
  --url https://api.getvespy.com/api/notifications/blasts/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "autoTranslate": true, "body": "example", "channels": [ "in_app" ], "target": { "propertyIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "tenantIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "unitIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }, "title": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
autoTranslate
boolean
body
required
string
>= 1 characters <= 4000 characters
channels
required
Array<string>
>= 1 items <= 3 items
Allowed values: in_app email sms
target
required
Any of:
object
propertyIds
required
Array<string>
<= 250 items
tenantIds
Array<string>
<= 1000 items
unitIds
Array<string>
<= 500 items
title
required
string
>= 1 characters <= 160 characters

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
blast
required
object
autoTranslate
required
boolean
body
required
string
>= 1 characters <= 4000 characters
channels
required
Array<string>
Allowed values: in_app email sms
createdAt
required
string format: date-time
id
required
string format: uuid
languageCounts
required
object
key
additional properties
integer
recipientCount
required
integer
skippedUnlinkedTenantCount
required
integer
status
required
string
Allowed values: draft queued sending completed failed
title
required
string
>= 1 characters <= 160 characters
versions
required
Array<object>
object
aiTranslated
required
boolean
body
required
string
>= 1 characters <= 8000 characters
language
required
string
>= 2 characters <= 32 characters
title
required
string
>= 1 characters <= 160 characters
Example
{
  "blast": {
    "channels": [
      "in_app"
    ],
    "status": "draft"
  }
}

400

Section titled “400”

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"
}

401

Section titled “401”

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"
}

403

Section titled “403”

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"
}