Skip to content

ip_release_campaign.notice

Browse notices queued for all users in a release campaign

Index

Path
GET /v7.0/ip_release_campaigns/{ip_release_campaign_id}/notices
Description
Authentication required
yes
Scope
ip_release_campaign.notice#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
notice
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
notices
ParameterTypeDescription
id
ID
 Integer
event
Notice type
 String
subject
Subject
 String
original_user_id
Original user ID
 Integer
user_login
User login
 String
created_at
Queued at
 Datetime
created_by
Queued by
 Resource
created_by_login
Queued by login
 String
mail_log
Mail log
 Resource