AWSPinpointTargetingUpdateSmsTemplateRequest

Objective-C

@interface AWSPinpointTargetingUpdateSmsTemplateRequest

Swift

class AWSPinpointTargetingUpdateSmsTemplateRequest

  • Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

    If you don’t specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don’t specify a value for the version parameter. Otherwise, an error will occur.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable createNewVersion;

    Swift

    var createNewVersion: NSNumber? { get set }

  • Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingSMSTemplateRequest *_Nullable SMSTemplateRequest;

    Swift

    var smsTemplateRequest: AWSPinpointTargetingSMSTemplateRequest? { get set }

  • The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable templateName;

    Swift

    var templateName: String? { get set }

  • The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

    If you don’t specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable version;

    Swift

    var version: String? { get set }