Skip to content
Vespy API

Create a notification blast as a draft, a schedule, or an immediate send

POST
/api/notifications/blasts
curl --request POST \
  --url https://api.getvespy.com/api/notifications/blasts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "autoTranslate": true, "body": "example", "channels": [ "in_app" ], "mode": "draft", "scheduledAt": "2026-04-15T12:00:00Z", "target": { "propertyIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "tenantIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "unitIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }, "title": "example", "versions": [ { "aiTranslated": true, "body": "example", "language": "example", "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
mode
required
string
Allowed values: draft schedule send
scheduledAt
string format: date-time
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
versions
Array<object>
>= 1 items <= 32 items
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

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
blast
required
object
actorUser
required
object
fullName
required
string
>= 1 characters <= 160 characters
id
required
string format: uuid
autoTranslate
required
boolean
body
required
string
>= 1 characters <= 4000 characters
channels
required
Array<string>
Allowed values: in_app email sms
completedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
error
required
string
nullable
id
required
string format: uuid
languageCount
required
integer
languageCounts
required
object
key
additional properties
integer
queuedAt
required
string format: date-time
nullable
recipientCount
required
integer
recipientCountIsEstimate
required
boolean
recipientStats
required
object
dispatched
required
integer
failed
required
integer
pending
required
integer
total
required
integer
scheduledAt
required
string format: date-time
nullable
skippedUnlinkedTenantCount
required
integer
status
required
string
Allowed values: draft scheduled queued sending completed failed
target
required
object
propertyIds
required
Array<string>
tenantIds
required
Array<string>
unitIds
required
Array<string>
targetSummary
required
object
properties
required
Array<object>
object
id
required
string format: uuid
label
required
string
tenants
required
Array<object>
object
id
required
string format: uuid
label
required
string
units
required
Array<object>
object
id
required
string format: uuid
label
required
string
title
required
string
>= 1 characters <= 160 characters
updatedAt
required
string format: date-time
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"
}

429

Section titled “429”

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

503

Section titled “503”

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