Create Notification

URL Expired

The URL for this request expired after 30 days.

Schema Definitions

• senderId
  Type: string
  Required: Yes
  Description: ID of the entity sending the notification. This can be ID of client user, internal user, or a company.

• recipientId
  Type: string
  Deprecated. Use recipientClientId, recipientCompanyId and recipientInternalUserId instead.

• deliveryTargets
  Type: object
  Description: The notification details for each delivery target.

• recipientClientId
  Type: string
  Description: ID of the client receiving the notification. This is required when sending a notification to a client.

• recipientCompanyId
  Type: string
  Description: ID of the company receiving the notification. This is required when sending a notification to a client that has more than one company.

• recipientInternalUserId
  Type: string
  Description: ID of the internal user receiving the notification. This is required when sending a notification to an internal user.

• senderCompanyId
  Type: string
  Description: 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.

HTTP Response Codes

• 200
  Description: Request successful.

• 400
  Description: Bad request.

Example cURL Request

curl --request POST \
     --url https://api.assembly.com/v1/notifications \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response Format

• application/json
• 200 - Result
• 400 - Result