Skip to main content

AddonCreateParams

Initial survey or CTA values for addonCreate; content is serialized separately from the audience definition.

input AddonCreateParams {
name: String!
content: String!
audienceDefinition: String
active: Boolean!
addonTemplateId: Int
suggestionId: Int
draftName: String
draftContent: String
type: AddonType!
goalId: Int
}

Fields​

AddonCreateParams.name ● String! non-null scalar​

Display name for the add-on.

AddonCreateParams.content ● String! non-null scalar​

JSON-encoded add-on content matching the current contract

AddonCreateParams.audienceDefinition ● String scalar​

JSON-encoded string. Audience object per audienceDefinitionContract; null targets all. Use before publication. Example: {"version":1,"operator":"and","conditions":[{"criteria":"device","comparison":"any","value":["phone"]}]}

AddonCreateParams.active ● Boolean! non-null scalar​

False saves an unpublished draft; true publishes and activates it immediately.

AddonCreateParams.addonTemplateId ● Int scalar​

Optional template ID from addonTemplatesList.

AddonCreateParams.suggestionId ● Int scalar​

Optional suggestion ID from addonSuggestionsList.

AddonCreateParams.draftName ● String scalar​

Optional saved draft name.

AddonCreateParams.draftContent ● String scalar​

Optional JSON-encoded unpublished draft content matching the current contract

AddonCreateParams.type ● AddonType! non-null enum​

SURVEY for questionnaires or CTA for calls to action.

AddonCreateParams.goalId ● Int scalar​

Optional goal ID from goalRefList to link to this add-on.

Member Of​

addonCreate mutation