All Implemented Interfaces:

com.growsurf.api.core.Params
```
public final class CampaignCreateParams
 implements Params
                    
```
Creates a new program pre-populated with type-appropriate defaults, plus any optional inline rewards. The new program is created in DRAFT status and owned by the API key's account. Requires a verified account email and a paid plan (referral) or a payment source on file (affiliate); subject to your plan's program limit.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CampaignCreateParams.Builder`	A builder for CampaignCreateParams.
`public final class`	`CampaignCreateParams.Body`	Request body for creating a program. Only `type` is required; everything else is server-defaulted.
`public final class`	`CampaignCreateParams.Type`	The program type. Immutable after creation.
`public final class`	`CampaignCreateParams.Reward`	Request body for creating a campaign reward. `type` is required and must be compatible with the program type.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final CampaignCreateParams.Type`	`type()`	The program type.
`final Optional<String>`	`name()`	The program name.
`final Optional<String>`	`companyName()`
`final Optional<String>`	`companyLogoImageUrl()`
`final Optional<String>`	`currencyIso()`	ISO 4217 currency code.
`final Optional<List<CampaignCreateParams.Reward>>`	`rewards()`	Optional inline rewards to create with the program.
`final JsonField<CampaignCreateParams.Type>`	`_type()`	Returns the raw JSON value of type.
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final JsonField<String>`	`_companyName()`	Returns the raw JSON value of companyName.
`final JsonField<String>`	`_companyLogoImageUrl()`	Returns the raw JSON value of companyLogoImageUrl.
`final JsonField<String>`	`_currencyIso()`	Returns the raw JSON value of currencyIso.
`final JsonField<List<CampaignCreateParams.Reward>>`	`_rewards()`	Returns the raw JSON value of rewards.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final CampaignCreateParams.Builder`	`toBuilder()`
`final CampaignCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static CampaignCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of CampaignCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - type
```
 final CampaignCreateParams.Type type()
```
    The program type. Immutable after creation.
  - name
```
 final Optional<String> name()
```
    The program name. Defaults to "Untitled Program".
  - companyName
```
 final Optional<String> companyName()
```
  - companyLogoImageUrl
```
 final Optional<String> companyLogoImageUrl()
```
  - currencyIso
```
 final Optional<String> currencyIso()
```
    ISO 4217 currency code. Defaults to USD. Chosen when the program is created and immutable afterward — it cannot be changed on update.
  - rewards
```
 final Optional<List<CampaignCreateParams.Reward>> rewards()
```
    Optional inline rewards to create with the program.
  - _type
```
 final JsonField<CampaignCreateParams.Type> _type()
```
    Returns the raw JSON value of type.
    Unlike type, this method doesn't throw if the JSON field has an unexpected type.
  - _name
```
 final JsonField<String> _name()
```
    Returns the raw JSON value of name.
    Unlike name, this method doesn't throw if the JSON field has an unexpected type.
  - _companyName
```
 final JsonField<String> _companyName()
```
    Returns the raw JSON value of companyName.
    Unlike companyName, this method doesn't throw if the JSON field has an unexpected type.
  - _companyLogoImageUrl
```
 final JsonField<String> _companyLogoImageUrl()
```
    Returns the raw JSON value of companyLogoImageUrl.
    Unlike companyLogoImageUrl, this method doesn't throw if the JSON field has an unexpected type.
  - _currencyIso
```
 final JsonField<String> _currencyIso()
```
    Returns the raw JSON value of currencyIso.
    Unlike currencyIso, this method doesn't throw if the JSON field has an unexpected type.
  - _rewards
```
 final JsonField<List<CampaignCreateParams.Reward>> _rewards()
```
    Returns the raw JSON value of rewards.
    Unlike rewards, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final CampaignCreateParams.Builder toBuilder()
```
  - _body
```
 final CampaignCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static CampaignCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of CampaignCreateParams.
    The following fields are required:
    .type()

Class CampaignCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

type

name

companyName

companyLogoImageUrl

currencyIso

rewards

_type

_name

_companyName

_companyLogoImageUrl

_currencyIso

_rewards

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder