Marketing

Overview

Available Operations

TemplatesListEmail - List Email Templates
CreateEmailTemplate - Create Email Templates
GetEmailTemplate - Get Email Templates
UpdateEmailTemplate - Update Email Templates
TemplatesListInApp - List In-App Templates
CreateInAppTemplate - Create In-App Template
ListSmsTemplates - List SMS Templates
CreateSmsTemplate - Create SMS Template
UpdateSmsTemplate - Update SMS Template
~~ListOmniChannelTemplates~~ - List Omni-Channel Templates ⚠️ Deprecated
~~GetOmniChannelTemplate~~ - Get Omni-Channel Template ⚠️ Deprecated
~~UpdateOmniChannelTemplate~~ - Update Omni-Channel Template ⚠️ Deprecated
TemplatesListPush - List Push Templates
UpdatePushTemplate - Update Push Template
ListContentBlocks - List Content Blocks
CreateContentBlock - Create Content Block
GetContentBlock - Get Content Blocks

TemplatesListEmail

List Email Templates

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingListEmailTemplatesRequest req = new MarketingListEmailTemplatesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields",
    Filter = new MarketingListEmailTemplatesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

MarketingListEmailTemplatesResponse? res = await sdk.Marketing.TemplatesListEmailAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

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

Response

MarketingListEmailTemplatesResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

CreateEmailTemplate

Create Email Templates

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Marketing.CreateEmailTemplateAsync(
    xAccountId: "<id>",
    marketingCreateEmailTemplateRequestDto: new MarketingCreateEmailTemplateRequestDto() {
        Messages = new List<EmailMessages>() {
            new EmailMessages() {
                Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                MessageType = null,
            },
        },
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`MarketingCreateEmailTemplateRequestDto`	MarketingCreateEmailTemplateRequestDto	✔️	N/A
`Prefer`	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

MarketingCreateEmailTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetEmailTemplate

Get Email Templates

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingGetEmailTemplateRequest req = new MarketingGetEmailTemplateRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Marketing.GetEmailTemplateAsync(req);

// handle response

Parameters

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

Response

MarketingGetEmailTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

UpdateEmailTemplate

Update Email Templates

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Marketing.UpdateEmailTemplateAsync(
    xAccountId: "<id>",
    id: "<id>",
    marketingCreateEmailTemplateRequestDto: new MarketingCreateEmailTemplateRequestDto() {
        Messages = new List<EmailMessages>() {
            new EmailMessages() {
                Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                MessageType = new EmailMessagesMessageType() {
                    Value = EmailMessagesValue.Email,
                    SourceValue = EmailMessagesSourceValueUnion.CreateStr(
                        "Email"
                    ),
                },
            },
        },
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`MarketingCreateEmailTemplateRequestDto`	MarketingCreateEmailTemplateRequestDto	✔️	N/A
`Prefer`	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

MarketingUpdateEmailTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

TemplatesListInApp

List In-App Templates

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingListInAppTemplatesRequest req = new MarketingListInAppTemplatesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields",
    Filter = null,
    Prefer = "heartbeat",
};

MarketingListInAppTemplatesResponse? res = await sdk.Marketing.TemplatesListInAppAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

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

Response

MarketingListInAppTemplatesResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

CreateInAppTemplate

Create In-App Template

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Marketing.CreateInAppTemplateAsync(
    xAccountId: "<id>",
    marketingCreateInAppTemplateRequestDto: new MarketingCreateInAppTemplateRequestDto() {
        Messages = new List<InAppMessages>() {
            new InAppMessages() {
                Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                MessageType = new InAppMessagesMessageType() {
                    Value = InAppMessagesValue.Email,
                    SourceValue = InAppMessagesSourceValueUnion.CreateStr(
                        "Email"
                    ),
                },
            },
        },
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`MarketingCreateInAppTemplateRequestDto`	MarketingCreateInAppTemplateRequestDto	✔️	N/A
`Prefer`	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

MarketingCreateInAppTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListSmsTemplates

List SMS Templates

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingListSmsTemplatesRequest req = new MarketingListSmsTemplatesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields",
    Filter = new MarketingListSmsTemplatesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

MarketingListSmsTemplatesResponse? res = await sdk.Marketing.ListSmsTemplatesAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

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

Response

MarketingListSmsTemplatesResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

CreateSmsTemplate

Create SMS Template

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Marketing.CreateSmsTemplateAsync(
    xAccountId: "<id>",
    marketingCreateSmsTemplateRequestDto: new MarketingCreateSmsTemplateRequestDto() {
        Messages = new List<SmsMessages>() {
            new SmsMessages() {
                Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                MessageType = new SmsMessagesMessageType() {
                    Value = SmsMessagesValue.Email,
                    SourceValue = SmsMessagesSourceValueUnion.CreateStr(
                        "Email"
                    ),
                },
            },
        },
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`MarketingCreateSmsTemplateRequestDto`	MarketingCreateSmsTemplateRequestDto	✔️	N/A
`Prefer`	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

MarketingCreateSmsTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

UpdateSmsTemplate

Update SMS Template

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Marketing.UpdateSmsTemplateAsync(
    xAccountId: "<id>",
    id: "<id>",
    marketingCreateSmsTemplateRequestDto: new MarketingCreateSmsTemplateRequestDto() {
        Messages = new List<SmsMessages>() {
            new SmsMessages() {
                Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                MessageType = new SmsMessagesMessageType() {
                    Value = SmsMessagesValue.Email,
                    SourceValue = SmsMessagesSourceValueUnion.CreateStr(
                        "Email"
                    ),
                },
            },
        },
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`MarketingCreateSmsTemplateRequestDto`	MarketingCreateSmsTemplateRequestDto	✔️	N/A
`Prefer`	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

MarketingUpdateSmsTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListOmniChannelTemplates

List Omni-Channel Templates

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

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingListOmniChannelTemplatesRequest req = new MarketingListOmniChannelTemplatesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields",
    Filter = new MarketingListOmniChannelTemplatesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

MarketingListOmniChannelTemplatesResponse? res = await sdk.Marketing.ListOmniChannelTemplatesAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

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

Response

MarketingListOmniChannelTemplatesResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetOmniChannelTemplate

Get Omni-Channel Template

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

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingGetOmniChannelTemplateRequest req = new MarketingGetOmniChannelTemplateRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Marketing.GetOmniChannelTemplateAsync(req);

// handle response

Parameters

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

Response

MarketingGetOmniChannelTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

UpdateOmniChannelTemplate

Update Omni-Channel Template

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

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Marketing.UpdateOmniChannelTemplateAsync(
    xAccountId: "<id>",
    id: "<id>",
    marketingCreateTemplateRequestDto: new MarketingCreateTemplateRequestDto() {
        Messages = new List<CreateMessage>() {
            new CreateMessage() {
                Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                MessageType = new CreateMessageMessageType() {
                    Value = CreateMessageValue.Email,
                    SourceValue = CreateMessageSourceValueUnion.CreateStr(
                        "Email"
                    ),
                },
            },
        },
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`MarketingCreateTemplateRequestDto`	MarketingCreateTemplateRequestDto	✔️	N/A
`Prefer`	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

MarketingUpdateOmniChannelTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

TemplatesListPush

List Push Templates

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingListPushTemplatesRequest req = new MarketingListPushTemplatesRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields",
    Filter = new MarketingListPushTemplatesFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

MarketingListPushTemplatesResponse? res = await sdk.Marketing.TemplatesListPushAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

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

Response

MarketingListPushTemplatesResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

UpdatePushTemplate

Update Push Template

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Marketing.UpdatePushTemplateAsync(
    xAccountId: "<id>",
    id: "<id>",
    marketingCreatePushTemplateRequestDto: new MarketingCreatePushTemplateRequestDto() {
        Messages = new List<PushMessages>() {
            new PushMessages() {
                Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                MessageType = new PushMessagesMessageType() {
                    Value = PushMessagesValue.Email,
                    SourceValue = PushMessagesSourceValueUnion.CreateStr(
                        "Email"
                    ),
                },
            },
        },
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`MarketingCreatePushTemplateRequestDto`	MarketingCreatePushTemplateRequestDto	✔️	N/A
`Prefer`	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

MarketingUpdatePushTemplateResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListContentBlocks

List Content Blocks

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingListContentBlocksRequest req = new MarketingListContentBlocksRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields",
    Filter = new MarketingListContentBlocksFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

MarketingListContentBlocksResponse? res = await sdk.Marketing.ListContentBlocksAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

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

Response

MarketingListContentBlocksResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

CreateContentBlock

Create Content Block

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Marketing.CreateContentBlockAsync(
    xAccountId: "<id>",
    marketingCreateContentBlocksRequestDto: new MarketingCreateContentBlocksRequestDto() {
        Type = new MarketingCreateContentBlocksRequestDtoType() {
            Value = MarketingCreateContentBlocksRequestDtoValue.Html,
            SourceValue = MarketingCreateContentBlocksRequestDtoSourceValueUnion.CreateStr(
                "text"
            ),
        },
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`MarketingCreateContentBlocksRequestDto`	MarketingCreateContentBlocksRequestDto	✔️	N/A
`Prefer`	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

MarketingCreateContentBlockResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetContentBlock

Get Content Blocks

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

MarketingGetContentBlockRequest req = new MarketingGetContentBlockRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Marketing.GetContentBlockAsync(req);

// handle response

Parameters

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

Response

MarketingGetContentBlockResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Marketing

Overview

Available Operations

TemplatesListEmail

Example Usage

Parameters

Response

Errors

CreateEmailTemplate

Example Usage

Parameters

Response

Errors

GetEmailTemplate

Example Usage

Parameters

Response

Errors

UpdateEmailTemplate

Example Usage

Parameters

Response

Errors

TemplatesListInApp

Example Usage

Parameters

Response

Errors

CreateInAppTemplate

Example Usage

Parameters

Response

Errors

ListSmsTemplates

Example Usage

Parameters

Response

Errors

CreateSmsTemplate

Example Usage

Parameters

Response

Errors

UpdateSmsTemplate

Example Usage

Parameters

Response

Errors

ListOmniChannelTemplates

Example Usage

Parameters

Response

Errors

GetOmniChannelTemplate

Example Usage

Parameters

Response

Errors

UpdateOmniChannelTemplate

Example Usage

Parameters

Response

Errors

TemplatesListPush

Example Usage

Parameters

Response

Errors

UpdatePushTemplate

Example Usage

Parameters

Response

Errors

ListContentBlocks