Section ID:
DOC-API-MODEL-schema-1kcu6c9rot#overview
InboxMessageAction
Interactive action attached to an inbox message, including completion state.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#field-actionidSection ID: DOC-API-MODEL-schema-1kcu6c9rot#response-field-actionidactionId | string | Optional | Identifier of an action attached to the inbox message. |
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#field-labelSection ID: DOC-API-MODEL-schema-1kcu6c9rot#response-field-labellabel | string | Optional | Display label for the inbox action. |
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#field-urlSection ID: DOC-API-MODEL-schema-1kcu6c9rot#response-field-urlurl | string | Optional | Destination URL opened by this inbox action. |
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#field-isprimarySection ID: DOC-API-MODEL-schema-1kcu6c9rot#response-field-isprimaryisPrimary | boolean | Optional | Whether the inbox action is designated as the primary action. |
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#field-completedSection ID: DOC-API-MODEL-schema-1kcu6c9rot#response-field-completedcompleted | boolean | Optional | Whether the user has completed this action via CompleteInboxAction. |
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#field-completedatSection ID: DOC-API-MODEL-schema-1kcu6c9rot#response-field-completedatcompletedAt | string (date-time) | Optional | Time when this inbox action was marked complete. |
Where used
Section ID: DOC-API-MODEL-schema-1kcu6c9rot#where-used
| Reference | Relationship |
|---|---|
| Get inbox feed messages | POST /api/v1/notifications/get-inbox-feed |
Models containing this value
| Model | Relationship |
|---|---|
| InboxMessage | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1kcu6c9rot