Create Notification

post

https://api.assembly.com/v1/notifications

Creates a notification in a workspace.

Body Params

senderId

string

required

ID of the entity sending the notification. This can be ID of client user, internal user, or a company.

recipientId

string

Deprecated. Use recipientClientId, recipientCompanyId and recipientInternalUserId instead.

deliveryTargets

object

The notification details for each delivery target.

recipientClientId

string

ID of the client receiving the notification. This required when sending a notification to a client.

recipientCompanyId

string

ID of the company receiving the notification. This is required when sending a notification to a client that has more than one company.

recipientInternalUserId

string

ID of the internal user receiving the notification. This is required when sending a notification to an internal user.

senderCompanyId

string

The ID of the company associated with the sender of this notification. This is required when the sender is a client with more than one company.

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200