Update a draft or scheduled notification blast

PATCH

/api/notifications/blasts/{id}

curl --request PATCH \
  --url https://api.getvespy.com/api/notifications/blasts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --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", "versions": [ { "aiTranslated": true, "body": "example", "language": "example", "title": "example" } ] }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

autoTranslate

boolean

body

string

>= 1 characters <= 4000 characters

channels

Array<string>

>= 1 items <= 3 items

Allowed values: in_app email sms

target

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

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

200

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

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

404

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