Struct CreateCampaignRequest 

pub struct CreateCampaignRequest {

    pub name: String,
    pub template_id: String,
    pub template_version: i32,
    pub user_ids: Vec<String>,
    pub workflow: Option<WorkflowDefinition>,
    pub sender_name: String,
    pub title: String,
    pub audience: Vec<AudienceMember>,
    pub include_restricted: bool,
    pub critical: bool,
    pub default_locale: String,
    pub wait_for_enrollment: bool,
    pub originating_archetype: Option<CampaignOriginatingArchetype>,
    pub objective_ids: Vec<String>,
}

Request to create a new campaign.

Fields

name: String

Human-readable campaign name (admin-facing label). Constraints: Max length 200 characters.

template_id: String

ID of the template to use for rendering messages. Constraints: UUID format (36 characters).

template_version: i32

Version of the template to pin for this campaign.

user_ids: Vec<String>

List of user IDs that form the campaign audience. Constraints: Max 100000 items.

workflow: Option<WorkflowDefinition>

Workflow DAG defining the campaign’s automation steps. Required: CreateCampaign rejects a request with no workflow (INVALID_ARGUMENT) and does not substitute a default. The definition MUST validate as an acyclic graph of well-formed steps.

sender_name: String

Display name of the sender shown to recipients (e.g. “HR Team”). Constraints: Max length 200 characters.

title: String

Optional user-facing title override. If empty, the template title is used. Constraints: Max length 200 characters.

audience: Vec<AudienceMember>

Rich audience with per-user template variables. When set, takes precedence over user_ids. Constraints: Max 100000 items.

include_restricted: bool

Whether to include users with processing_restricted=true in the audience. Default false: restricted users are excluded. Set true only with Art. 18(2) legal basis.

critical: bool

Whether this campaign’s notifications break through Do Not Disturb / Focus mode.

default_locale: String

Optional locale override for all recipients.

wait_for_enrollment: bool

Whether the campaign deadline should wait for users without registered devices. When true, NO_DEVICE users are not decremented from pending_count, allowing them to acknowledge via inbox after installing the app.

originating_archetype: Option<CampaignOriginatingArchetype>

Optional. Set when the campaign is created from a Compass archetype CTA. The server validates the caller has access to group_id and that archetype_label exists in the group’s current archetype set; cross-org group_id returns PERMISSION_DENIED, unknown label returns NOT_FOUND.

objective_ids: Vec<String>

Objectives this campaign serves. Declaring the objective at creation is the point at which a response rate stops being the result and becomes evidence about something the organization was trying to achieve. Empty is allowed and changes nothing about how the campaign runs. Unknown or cross-org IDs return NOT_FOUND.

Trait Implementations

impl Clone for CreateCampaignRequest

fn clone(&self) -> CreateCampaignRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCampaignRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateCampaignRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for CreateCampaignRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CreateCampaignRequest

fn eq(&self, other: &CreateCampaignRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CreateCampaignRequest