InboxMessageAction
Interactive action attached to an inbox message, including completion state.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
actionId | string | Optional | Identifier of an action attached to the inbox message. |
label | string | Optional | Display label for the inbox action. |
url | string | Optional | Destination URL opened by this inbox action. |
isPrimary | boolean | Optional | Whether the inbox action is designated as the primary action. |
completed | boolean | Optional | Whether the user has completed this action via CompleteInboxAction. |
completedAt | string (date-time) | Optional | Time when this inbox action was marked complete. |
Where used
| Reference | Relationship |
|---|---|
| Get inbox feed messages | POST /api/v1/notifications/get-inbox-feed |
| InboxMessage | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-inbox-message-action.