Create Trust Center update - Vanta Developer Hub

POST

/

trust-centers

/

{slugId}

/

updates

Create Trust Center update

curl --request POST \
  --url https://api.vanta.com/v1/trust-centers/{slugId}/updates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "notifiedEmails": [
    "<string>"
  ],
  "subscriberGroupIds": [
    "<string>"
  ]
}
'

{
  "id": "a2f7e1b9d0c3f4e5a6c7b8d9",
  "title": "Example title",
  "description": "This is an example of an update's description.",
  "category": "GENERAL",
  "creationDate": "2020-01-01T00:00:00.000Z",
  "updatedDate": "2020-01-01T00:00:00.000Z",
  "visibilityType": "PUBLIC",
  "notifiedEmails": [
    "test@test.com"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

slugId

string

required

Body

application/json

title

string

required

Title of the update.

description

string

required

Description of the update.

category

enum<string>

required

Category of the update.

Available options:

GENERAL,

COMPLIANCE,

SECURITY,

PRIVACY,

INCIDENT,

ROADMAP

visibilityType

enum<string>

Visibility type of the update.

Available options:

PUBLIC,

PRIVATE

notifiedEmails

string[]

Additional one-off email addresses to notify. These are always sent regardless of notificationTarget.

notificationTarget

enum<string>

Controls which Trust Center subscribers are notified.

ALL: notifies all active subscribers
GROUPS: notifies only subscribers in the specified subscriberGroupIds
NONE: no subscribers are notified

Note: notifiedEmails are always sent regardless of this value.

Available options:

ALL,

GROUPS,

NONE

subscriberGroupIds

string[]

IDs of subscriber groups to notify. Required when notificationTarget is GROUPS.

Response

201 - application/json

Trust Center update created

id

string

required

Unique identifier for the update.

title

string

required

Title of the update.

description

string

required

Description of the update.

category

enum<string>

required

Category of the update.

Available options:

GENERAL,

COMPLIANCE,

SECURITY,

PRIVACY,

INCIDENT,

ROADMAP

creationDate

string<date-time>

required

Date the update was created.

updatedDate

string<date-time>

required

Date the viewer was last updated.

visibilityType

enum<string>

required

Visibility type of the update.

Available options:

PUBLIC,

PRIVATE

notifiedEmails

string[]

Emails to notify about the update.

Get Trust Center updateGets a specific update on a Trust Center.

⌘I

Create Trust Center update

curl --request POST \
  --url https://api.vanta.com/v1/trust-centers/{slugId}/updates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "notifiedEmails": [
    "<string>"
  ],
  "subscriberGroupIds": [
    "<string>"
  ]
}
'

{
  "id": "a2f7e1b9d0c3f4e5a6c7b8d9",
  "title": "Example title",
  "description": "This is an example of an update's description.",
  "category": "GENERAL",
  "creationDate": "2020-01-01T00:00:00.000Z",
  "updatedDate": "2020-01-01T00:00:00.000Z",
  "visibilityType": "PUBLIC",
  "notifiedEmails": [
    "test@test.com"
  ]
}