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

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

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

object

propertyIds

required

Array<string>

<= 250 items

tenantIds

Array<string>

<= 1000 items

unitIds

Array<string>

<= 500 items

object

object

propertyIds

Array<string>

<= 250 items

tenantIds

Array<string>

<= 1000 items

unitIds

required

Array<string>

<= 500 items

object

object

propertyIds

Array<string>

<= 250 items

tenantIds

required

Array<string>

<= 1000 items

unitIds

Array<string>

<= 500 items

title

required

string

>= 1 characters <= 160 characters

Responses

201

Default Response

Media typeapplication/json

object

preview

required

object

languageCounts

required

object

key

additional properties

integer

recipientCount

required

integer

skippedUnlinkedTenantCount

required

integer

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^generated

{
  "preview": {
    "languageCounts": {
      "additionalProperty": 1
    },
    "recipientCount": 1,
    "skippedUnlinkedTenantCount": 1,
    "versions": [
      {
        "aiTranslated": true,
        "body": "example",
        "language": "example",
        "title": "example"
      }
    ]
  }
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}