Campaigns Object Models
Objects used to build Campaign trigger requests and parse Campaign responses.
nexthink_api.Campaigns
Models for the Nexthink Campaigns API.
NxtCampaignTriggerErrorResponse
Bases: BaseModel
Error details returned by the Campaigns API.
code: str = Field(min_length=1)
class-attribute
instance-attribute
message: str = Field(min_length=1)
class-attribute
instance-attribute
NxtCampaignTriggerRequest
Bases: BaseModel
Request body used to trigger a campaign for user SIDs.
campaignNqlId: str = Field(min_length=1)
class-attribute
instance-attribute
userSid: list[str] = Field(min_length=1, max_length=10000)
class-attribute
instance-attribute
expiresInMinutes: int = Field(ge=1, le=525600)
class-attribute
instance-attribute
parameters: dict[str, str] | None = Field(default=None, max_length=30)
class-attribute
instance-attribute
NxtCampaignTriggerResponseDetails
Bases: BaseModel
Per-user result returned by a Campaigns trigger response.
userSid: str
instance-attribute
requestId: str | None = None
class-attribute
instance-attribute
message: str | None = None
class-attribute
instance-attribute
NxtCampaignTriggerSuccessResponse
Bases: BaseModel
Response returned when campaign trigger requests are created.