Marketing

Overview

Available Operations

create_content_block - Create Content Block
create_email_template - Create Email Templates
create_in_app_template - Create In-App Template
~~create_omni_channel_template~~ - Create Omni-Channel Template ⚠️ Deprecated
create_push_template - Create Push Template
create_sms_template - Create SMS Template
get_campaign - Get campaign
get_content_block - Get Content Blocks
get_email_template - Get Email Templates
get_in_app_template - Get In-App Template
~~get_omni_channel_template~~ - Get Omni-Channel Template ⚠️ Deprecated
get_push_template - Get Push Template
get_sms_template - Get SMS Template
list_campaigns - List campaigns
list_content_blocks - List Content Blocks
list_email_templates - List Email Templates
list_in_app_templates - List In-App Templates
~~list_omni_channel_templates~~ - List Omni-Channel Templates ⚠️ Deprecated
list_push_templates - List Push Templates
list_sms_templates - List SMS Templates
update_content_block - Update Content Block
update_email_template - Update Email Templates
update_in_app_template - Update In-App Template
~~update_omni_channel_template~~ - Update Omni-Channel Template ⚠️ Deprecated
update_push_template - Update Push Template
update_sms_template - Update SMS Template

create_content_block

Create Content Block

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.create_content_block(marketing_create_content_blocks_request_dto: Models::Shared::MarketingCreateContentBlocksRequestDto.new(
  passthrough: {
    'other_known_names' => 'John Doe',
  },
  type: Models::Shared::MarketingCreateContentBlocksRequestDtoType.new(
    source_value: 'text',
    value: Models::Shared::MarketingCreateContentBlocksRequestDtoValue::HTML
  )
), x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_content_blocks_request_dto`	Models::Shared::MarketingCreateContentBlocksRequestDto	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingCreateContentBlockResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

create_email_template

Create Email Templates

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.create_email_template(marketing_create_email_template_request_dto: Models::Shared::MarketingCreateEmailTemplateRequestDto.new(
  messages: [
    Models::Shared::EmailMessages.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: nil,
      remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3'
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_email_template_request_dto`	Models::Shared::MarketingCreateEmailTemplateRequestDto	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingCreateEmailTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

create_in_app_template

Create In-App Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.create_in_app_template(marketing_create_in_app_template_request_dto: Models::Shared::MarketingCreateInAppTemplateRequestDto.new(
  messages: [
    Models::Shared::InAppMessages.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::InAppMessagesMessageType.new(
        source_value: 'Email',
        value: Models::Shared::InAppMessagesValue::EMAIL
      ),
      remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3'
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_in_app_template_request_dto`	Models::Shared::MarketingCreateInAppTemplateRequestDto	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingCreateInAppTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

create_omni_channel_template

Create Omni-Channel Template

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.create_omni_channel_template(marketing_create_template_request_dto: Models::Shared::MarketingCreateTemplateRequestDto.new(
  messages: [
    Models::Shared::CreateMessage.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::MessageType.new(
        source_value: 'Email',
        value: Models::Shared::CreateMessageValue::EMAIL
      )
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_template_request_dto`	Models::Shared::MarketingCreateTemplateRequestDto	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingCreateOmniChannelTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

create_push_template

Create Push Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.create_push_template(marketing_create_push_template_request_dto: Models::Shared::MarketingCreatePushTemplateRequestDto.new(
  messages: [
    Models::Shared::PushMessages.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::PushMessagesMessageType.new(
        source_value: 'Email',
        value: Models::Shared::PushMessagesValue::EMAIL
      ),
      remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3'
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_push_template_request_dto`	Models::Shared::MarketingCreatePushTemplateRequestDto	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingCreatePushTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

create_sms_template

Create SMS Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.create_sms_template(marketing_create_sms_template_request_dto: Models::Shared::MarketingCreateSmsTemplateRequestDto.new(
  messages: [
    Models::Shared::SmsMessages.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::SmsMessagesMessageType.new(
        source_value: 'Email',
        value: Models::Shared::SmsMessagesValue::EMAIL
      ),
      remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3'
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_sms_template_request_dto`	Models::Shared::MarketingCreateSmsTemplateRequestDto	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingCreateSmsTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

get_campaign

Get campaign

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingGetCampaignRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.marketing.get_campaign(request: req)

unless res.campaign_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingGetCampaignRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingGetCampaignResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

get_content_block

Get Content Blocks

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingGetContentBlockRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.marketing.get_content_block(request: req)

unless res.content_block_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingGetContentBlockRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingGetContentBlockResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

get_email_template

Get Email Templates

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingGetEmailTemplateRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.marketing.get_email_template(request: req)

unless res.email_template_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingGetEmailTemplateRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingGetEmailTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

get_in_app_template

Get In-App Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingGetInAppTemplateRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.marketing.get_in_app_template(request: req)

unless res.in_app_template_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingGetInAppTemplateRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingGetInAppTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

get_omni_channel_template

Get Omni-Channel Template

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingGetOmniChannelTemplateRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.marketing.get_omni_channel_template(request: req)

unless res.template_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingGetOmniChannelTemplateRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingGetOmniChannelTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

get_push_template

Get Push Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingGetPushTemplateRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.marketing.get_push_template(request: req)

unless res.push_template_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingGetPushTemplateRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingGetPushTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

get_sms_template

Get SMS Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingGetSmsTemplateRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.marketing.get_sms_template(request: req)

unless res.sms_template_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingGetSmsTemplateRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingGetSmsTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

list_campaigns

List campaigns

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingListCampaignsRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields',
  filter: Models::Operations::MarketingListCampaignsQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.marketing.list_campaigns(request: req)

unless res.campaigns_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingListCampaignsRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingListCampaignsResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

list_content_blocks

List Content Blocks

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingListContentBlocksRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields',
  filter: Models::Operations::MarketingListContentBlocksQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.marketing.list_content_blocks(request: req)

unless res.content_blocks_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingListContentBlocksRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingListContentBlocksResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

list_email_templates

List Email Templates

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingListEmailTemplatesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  filter: Models::Operations::MarketingListEmailTemplatesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.marketing.list_email_templates(request: req)

unless res.email_templates_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingListEmailTemplatesRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingListEmailTemplatesResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

list_in_app_templates

List In-App Templates

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingListInAppTemplatesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  filter: nil,
  x_account_id: '<id>'
)
res = s.marketing.list_in_app_templates(request: req)

unless res.in_app_templates_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingListInAppTemplatesRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingListInAppTemplatesResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

list_omni_channel_templates

List Omni-Channel Templates

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingListOmniChannelTemplatesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  filter: Models::Operations::MarketingListOmniChannelTemplatesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.marketing.list_omni_channel_templates(request: req)

unless res.templates_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingListOmniChannelTemplatesRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingListOmniChannelTemplatesResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

list_push_templates

List Push Templates

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingListPushTemplatesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  filter: Models::Operations::MarketingListPushTemplatesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.marketing.list_push_templates(request: req)

unless res.push_templates_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingListPushTemplatesRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingListPushTemplatesResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

list_sms_templates

List SMS Templates

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::MarketingListSmsTemplatesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
  filter: Models::Operations::MarketingListSmsTemplatesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.marketing.list_sms_templates(request: req)

unless res.sms_templates_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	Models::Operations::MarketingListSmsTemplatesRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::MarketingListSmsTemplatesResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

update_content_block

Update Content Block

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.update_content_block(marketing_create_content_blocks_request_dto: Models::Shared::MarketingCreateContentBlocksRequestDto.new(
  passthrough: {
    'other_known_names' => 'John Doe',
  },
  type: Models::Shared::MarketingCreateContentBlocksRequestDtoType.new(
    source_value: 'text',
    value: Models::Shared::MarketingCreateContentBlocksRequestDtoValue::HTML
  )
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_content_blocks_request_dto`	Models::Shared::MarketingCreateContentBlocksRequestDto	✔️	N/A
`id`	::String	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingUpdateContentBlockResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

update_email_template

Update Email Templates

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.update_email_template(marketing_create_email_template_request_dto: Models::Shared::MarketingCreateEmailTemplateRequestDto.new(
  messages: [
    Models::Shared::EmailMessages.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::EmailMessagesMessageType.new(
        source_value: 'Email',
        value: Models::Shared::EmailMessagesValue::EMAIL
      ),
      remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3'
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_email_template_request_dto`	Models::Shared::MarketingCreateEmailTemplateRequestDto	✔️	N/A
`id`	::String	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingUpdateEmailTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

update_in_app_template

Update In-App Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.update_in_app_template(marketing_create_in_app_template_request_dto: Models::Shared::MarketingCreateInAppTemplateRequestDto.new(
  messages: [
    Models::Shared::InAppMessages.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::InAppMessagesMessageType.new(
        source_value: 'Email',
        value: Models::Shared::InAppMessagesValue::EMAIL
      ),
      remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3'
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_in_app_template_request_dto`	Models::Shared::MarketingCreateInAppTemplateRequestDto	✔️	N/A
`id`	::String	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingUpdateInAppTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

update_omni_channel_template

Update Omni-Channel Template

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.update_omni_channel_template(marketing_create_template_request_dto: Models::Shared::MarketingCreateTemplateRequestDto.new(
  messages: [
    Models::Shared::CreateMessage.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::MessageType.new(
        source_value: 'Email',
        value: Models::Shared::CreateMessageValue::EMAIL
      )
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_template_request_dto`	Models::Shared::MarketingCreateTemplateRequestDto	✔️	N/A
`id`	::String	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingUpdateOmniChannelTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

update_push_template

Update Push Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.update_push_template(marketing_create_push_template_request_dto: Models::Shared::MarketingCreatePushTemplateRequestDto.new(
  messages: [
    Models::Shared::PushMessages.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::PushMessagesMessageType.new(
        source_value: 'Email',
        value: Models::Shared::PushMessagesValue::EMAIL
      ),
      remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3'
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_push_template_request_dto`	Models::Shared::MarketingCreatePushTemplateRequestDto	✔️	N/A
`id`	::String	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingUpdatePushTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

update_sms_template

Update SMS Template

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.marketing.update_sms_template(marketing_create_sms_template_request_dto: Models::Shared::MarketingCreateSmsTemplateRequestDto.new(
  messages: [
    Models::Shared::SmsMessages.new(
      id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
      message_type: Models::Shared::SmsMessagesMessageType.new(
        source_value: 'Email',
        value: Models::Shared::SmsMessagesValue::EMAIL
      ),
      remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3'
    ),
  ],
  passthrough: {
    'other_known_names' => 'John Doe',
  }
), id: '<id>', x_account_id: '<id>', prefer: 'heartbeat')

unless res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
`marketing_create_sms_template_request_dto`	Models::Shared::MarketingCreateSmsTemplateRequestDto	✔️	N/A
`id`	::String	✔️	N/A
`x_account_id`	::String	✔️	The account identifier
`prefer`	T.nilable(::String)	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

T.nilable(Models::Operations::MarketingUpdateSmsTemplateResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::PreconditionFailedResponse	412	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Marketing

Overview

Available Operations

create_content_block

Example Usage

Parameters

Response

Errors

create_email_template

Example Usage

Parameters

Response

Errors

create_in_app_template

Example Usage

Parameters

Response

Errors

create_omni_channel_template

Example Usage

Parameters

Response

Errors

create_push_template

Example Usage

Parameters

Response

Errors

create_sms_template

Example Usage

Parameters

Response

Errors

get_campaign

Example Usage

Parameters

Response

Errors

get_content_block

Example Usage

Parameters

Response

Errors

get_email_template

Example Usage

Parameters

Response

Errors

get_in_app_template

Example Usage

Parameters

Response

Errors

get_omni_channel_template

Example Usage

Parameters

Response

Errors

get_push_template

Example Usage

Parameters

Response

Errors

get_sms_template

Example Usage

Parameters

Response

Errors

list_campaigns

Example Usage

Parameters

Response

Errors

list_content_blocks