Marketing

Overview

Available Operations

listEmailTemplates - List Email Templates
createEmailTemplate - Create Email Templates
getEmailTemplate - Get Email Templates
updateEmailTemplate - Update Email Templates
listInAppTemplates - List In-App Templates
createInAppTemplate - Create In-App Template
getInAppTemplate - Get In-App Template
updateInAppTemplate - Update In-App Template
listSmsTemplates - List SMS Templates
createSmsTemplate - Create SMS Template
getSmsTemplate - Get SMS Template
updateSmsTemplate - Update SMS Template
~~listOmniChannelTemplates~~ - List Omni-Channel Templates ⚠️ Deprecated
~~createOmniChannelTemplate~~ - Create Omni-Channel Template ⚠️ Deprecated
~~getOmniChannelTemplate~~ - Get Omni-Channel Template ⚠️ Deprecated
~~updateOmniChannelTemplate~~ - Update Omni-Channel Template ⚠️ Deprecated
listPushTemplates - List Push Templates
createPushTemplate - Create Push Template
getPushTemplate - Get Push Template
updatePushTemplate - Update Push Template
listCampaigns - List campaigns
getCampaign - Get campaign
listContentBlocks - List Content Blocks
createContentBlock - Create Content Block
getContentBlock - Get Content Blocks
updateContentBlock - Update Content Block

listEmailTemplates

List Email Templates

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingListEmailTemplatesRequest(
    xAccountId: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    filter: new Operations\MarketingListEmailTemplatesQueryParamFilter(
        updatedAfter: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
    ),
    prefer: 'heartbeat',
);

$responses = $sdk->marketing->listEmailTemplates(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

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

Response

?Operations\MarketingListEmailTemplatesResponse

Errors

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

createEmailTemplate

Create Email Templates

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateEmailTemplateRequestDto = new Components\MarketingCreateEmailTemplateRequestDto(
    messages: [
        new Components\EmailMessages(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            remoteId: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: null,
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->createEmailTemplate(
    xAccountId: '<id>',
    marketingCreateEmailTemplateRequestDto: $marketingCreateEmailTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`marketingCreateEmailTemplateRequestDto`	Components\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

?Operations\MarketingCreateEmailTemplateResponse

Errors

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

getEmailTemplate

Get Email Templates

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingGetEmailTemplateRequest(
    xAccountId: '<id>',
    id: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    prefer: 'heartbeat',
);

$response = $sdk->marketing->getEmailTemplate(
    request: $request
);

if ($response->emailTemplateResult !== null) {
    // handle response
}

Parameters

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

Response

?Operations\MarketingGetEmailTemplateResponse

Errors

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

updateEmailTemplate

Update Email Templates

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateEmailTemplateRequestDto = new Components\MarketingCreateEmailTemplateRequestDto(
    messages: [
        new Components\EmailMessages(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            remoteId: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\MessageType(
                value: Components\EmailMessagesValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->updateEmailTemplate(
    xAccountId: '<id>',
    id: '<id>',
    marketingCreateEmailTemplateRequestDto: $marketingCreateEmailTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`id`	string	✔️	N/A
`marketingCreateEmailTemplateRequestDto`	Components\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

?Operations\MarketingUpdateEmailTemplateResponse

Errors

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

listInAppTemplates

List In-App Templates

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingListInAppTemplatesRequest(
    xAccountId: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    filter: null,
    prefer: 'heartbeat',
);

$responses = $sdk->marketing->listInAppTemplates(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

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

Response

?Operations\MarketingListInAppTemplatesResponse

Errors

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

createInAppTemplate

Create In-App Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateInAppTemplateRequestDto = new Components\MarketingCreateInAppTemplateRequestDto(
    messages: [
        new Components\InAppMessages(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            remoteId: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\InAppMessagesMessageType(
                value: Components\InAppMessagesValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->createInAppTemplate(
    xAccountId: '<id>',
    marketingCreateInAppTemplateRequestDto: $marketingCreateInAppTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`marketingCreateInAppTemplateRequestDto`	Components\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

?Operations\MarketingCreateInAppTemplateResponse

Errors

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

getInAppTemplate

Get In-App Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingGetInAppTemplateRequest(
    xAccountId: '<id>',
    id: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    prefer: 'heartbeat',
);

$response = $sdk->marketing->getInAppTemplate(
    request: $request
);

if ($response->inAppTemplateResult !== null) {
    // handle response
}

Parameters

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

Response

?Operations\MarketingGetInAppTemplateResponse

Errors

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

updateInAppTemplate

Update In-App Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateInAppTemplateRequestDto = new Components\MarketingCreateInAppTemplateRequestDto(
    messages: [
        new Components\InAppMessages(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            remoteId: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\InAppMessagesMessageType(
                value: Components\InAppMessagesValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->updateInAppTemplate(
    xAccountId: '<id>',
    id: '<id>',
    marketingCreateInAppTemplateRequestDto: $marketingCreateInAppTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`id`	string	✔️	N/A
`marketingCreateInAppTemplateRequestDto`	Components\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

?Operations\MarketingUpdateInAppTemplateResponse

Errors

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

listSmsTemplates

List SMS Templates

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingListSmsTemplatesRequest(
    xAccountId: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    filter: new Operations\MarketingListSmsTemplatesQueryParamFilter(
        updatedAfter: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
    ),
    prefer: 'heartbeat',
);

$responses = $sdk->marketing->listSmsTemplates(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

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

Response

?Operations\MarketingListSmsTemplatesResponse

Errors

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

createSmsTemplate

Create SMS Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateSmsTemplateRequestDto = new Components\MarketingCreateSmsTemplateRequestDto(
    messages: [
        new Components\SmsMessages(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            remoteId: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\SmsMessagesMessageType(
                value: Components\SmsMessagesValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->createSmsTemplate(
    xAccountId: '<id>',
    marketingCreateSmsTemplateRequestDto: $marketingCreateSmsTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`marketingCreateSmsTemplateRequestDto`	Components\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

?Operations\MarketingCreateSmsTemplateResponse

Errors

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

getSmsTemplate

Get SMS Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingGetSmsTemplateRequest(
    xAccountId: '<id>',
    id: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    prefer: 'heartbeat',
);

$response = $sdk->marketing->getSmsTemplate(
    request: $request
);

if ($response->smsTemplateResult !== null) {
    // handle response
}

Parameters

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

Response

?Operations\MarketingGetSmsTemplateResponse

Errors

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

updateSmsTemplate

Update SMS Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateSmsTemplateRequestDto = new Components\MarketingCreateSmsTemplateRequestDto(
    messages: [
        new Components\SmsMessages(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            remoteId: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\SmsMessagesMessageType(
                value: Components\SmsMessagesValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->updateSmsTemplate(
    xAccountId: '<id>',
    id: '<id>',
    marketingCreateSmsTemplateRequestDto: $marketingCreateSmsTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`id`	string	✔️	N/A
`marketingCreateSmsTemplateRequestDto`	Components\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

?Operations\MarketingUpdateSmsTemplateResponse

Errors

Error Type	Status Code	Content Type
Errors\BadRequestResponse	400	application/json
Errors\UnauthorizedResponse	401	application/json
Errors\ForbiddenResponse	403	application/json
Errors\NotFoundResponse	404	application/json
Errors\RequestTimedOutResponse	408	application/json
Errors\ConflictResponse	409	application/json
Errors\PreconditionFailedResponse	412	application/json
Errors\UnprocessableEntityResponse	422	application/json
Errors\TooManyRequestsResponse	429	application/json
Errors\InternalServerErrorResponse	500	application/json
Errors\NotImplementedResponse	501	application/json
Errors\BadGatewayResponse	502	application/json
Errors\SDKException	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

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingListOmniChannelTemplatesRequest(
    xAccountId: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    filter: new Operations\MarketingListOmniChannelTemplatesQueryParamFilter(
        updatedAfter: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
    ),
    prefer: 'heartbeat',
);

$responses = $sdk->marketing->listOmniChannelTemplates(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

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

Response

?Operations\MarketingListOmniChannelTemplatesResponse

Errors

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

createOmniChannelTemplate

Create Omni-Channel Template

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

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateTemplateRequestDto = new Components\MarketingCreateTemplateRequestDto(
    messages: [
        new Components\CreateMessage(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\CreateMessageMessageType(
                value: Components\CreateMessageValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->createOmniChannelTemplate(
    xAccountId: '<id>',
    marketingCreateTemplateRequestDto: $marketingCreateTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`marketingCreateTemplateRequestDto`	Components\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

?Operations\MarketingCreateOmniChannelTemplateResponse

Errors

Error Type	Status Code	Content Type
Errors\BadRequestResponse	400	application/json
Errors\UnauthorizedResponse	401	application/json
Errors\ForbiddenResponse	403	application/json
Errors\NotFoundResponse	404	application/json
Errors\RequestTimedOutResponse	408	application/json
Errors\ConflictResponse	409	application/json
Errors\PreconditionFailedResponse	412	application/json
Errors\UnprocessableEntityResponse	422	application/json
Errors\TooManyRequestsResponse	429	application/json
Errors\InternalServerErrorResponse	500	application/json
Errors\NotImplementedResponse	501	application/json
Errors\BadGatewayResponse	502	application/json
Errors\SDKException	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

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingGetOmniChannelTemplateRequest(
    xAccountId: '<id>',
    id: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    prefer: 'heartbeat',
);

$response = $sdk->marketing->getOmniChannelTemplate(
    request: $request
);

if ($response->templateResult !== null) {
    // handle response
}

Parameters

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

Response

?Operations\MarketingGetOmniChannelTemplateResponse

Errors

Error Type	Status Code	Content Type
Errors\BadRequestResponse	400	application/json
Errors\UnauthorizedResponse	401	application/json
Errors\ForbiddenResponse	403	application/json
Errors\NotFoundResponse	404	application/json
Errors\RequestTimedOutResponse	408	application/json
Errors\ConflictResponse	409	application/json
Errors\PreconditionFailedResponse	412	application/json
Errors\UnprocessableEntityResponse	422	application/json
Errors\TooManyRequestsResponse	429	application/json
Errors\InternalServerErrorResponse	500	application/json
Errors\NotImplementedResponse	501	application/json
Errors\BadGatewayResponse	502	application/json
Errors\SDKException	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

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateTemplateRequestDto = new Components\MarketingCreateTemplateRequestDto(
    messages: [
        new Components\CreateMessage(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\CreateMessageMessageType(
                value: Components\CreateMessageValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->updateOmniChannelTemplate(
    xAccountId: '<id>',
    id: '<id>',
    marketingCreateTemplateRequestDto: $marketingCreateTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`id`	string	✔️	N/A
`marketingCreateTemplateRequestDto`	Components\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

?Operations\MarketingUpdateOmniChannelTemplateResponse

Errors

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

listPushTemplates

List Push Templates

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingListPushTemplatesRequest(
    xAccountId: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    filter: new Operations\MarketingListPushTemplatesQueryParamFilter(
        updatedAfter: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
    ),
    prefer: 'heartbeat',
);

$responses = $sdk->marketing->listPushTemplates(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

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

Response

?Operations\MarketingListPushTemplatesResponse

Errors

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

createPushTemplate

Create Push Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreatePushTemplateRequestDto = new Components\MarketingCreatePushTemplateRequestDto(
    messages: [
        new Components\PushMessages(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            remoteId: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\PushMessagesMessageType(
                value: Components\PushMessagesValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->createPushTemplate(
    xAccountId: '<id>',
    marketingCreatePushTemplateRequestDto: $marketingCreatePushTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`marketingCreatePushTemplateRequestDto`	Components\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

?Operations\MarketingCreatePushTemplateResponse

Errors

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

getPushTemplate

Get Push Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingGetPushTemplateRequest(
    xAccountId: '<id>',
    id: '<id>',
    fields: 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields',
    prefer: 'heartbeat',
);

$response = $sdk->marketing->getPushTemplate(
    request: $request
);

if ($response->pushTemplateResult !== null) {
    // handle response
}

Parameters

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

Response

?Operations\MarketingGetPushTemplateResponse

Errors

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

updatePushTemplate

Update Push Template

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreatePushTemplateRequestDto = new Components\MarketingCreatePushTemplateRequestDto(
    messages: [
        new Components\PushMessages(
            id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            remoteId: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
            messageType: new Components\PushMessagesMessageType(
                value: Components\PushMessagesValue::Email,
                sourceValue: 'Email',
            ),
        ),
    ],
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->updatePushTemplate(
    xAccountId: '<id>',
    id: '<id>',
    marketingCreatePushTemplateRequestDto: $marketingCreatePushTemplateRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`id`	string	✔️	N/A
`marketingCreatePushTemplateRequestDto`	Components\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

?Operations\MarketingUpdatePushTemplateResponse

Errors

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

listCampaigns

List campaigns

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingListCampaignsRequest(
    xAccountId: '<id>',
    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: new Operations\MarketingListCampaignsQueryParamFilter(
        updatedAfter: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
    ),
    prefer: 'heartbeat',
);

$responses = $sdk->marketing->listCampaigns(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

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

Response

?Operations\MarketingListCampaignsResponse

Errors

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

getCampaign

Get campaign

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingGetCampaignRequest(
    xAccountId: '<id>',
    id: '<id>',
    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',
    prefer: 'heartbeat',
);

$response = $sdk->marketing->getCampaign(
    request: $request
);

if ($response->campaignResult !== null) {
    // handle response
}

Parameters

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

Response

?Operations\MarketingGetCampaignResponse

Errors

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

listContentBlocks

List Content Blocks

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;
use StackOne\client\Utils;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingListContentBlocksRequest(
    xAccountId: '<id>',
    fields: 'id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields',
    filter: new Operations\MarketingListContentBlocksQueryParamFilter(
        updatedAfter: Utils\Utils::parseDateTime('2020-01-01T00:00:00.000Z'),
    ),
    prefer: 'heartbeat',
);

$responses = $sdk->marketing->listContentBlocks(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

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

Response

?Operations\MarketingListContentBlocksResponse

Errors

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

createContentBlock

Create Content Block

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateContentBlocksRequestDto = new Components\MarketingCreateContentBlocksRequestDto(
    type: new Components\MarketingCreateContentBlocksRequestDtoType(
        value: Components\MarketingCreateContentBlocksRequestDtoValue::Html,
        sourceValue: 'text',
    ),
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->createContentBlock(
    xAccountId: '<id>',
    marketingCreateContentBlocksRequestDto: $marketingCreateContentBlocksRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`marketingCreateContentBlocksRequestDto`	Components\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

?Operations\MarketingCreateContentBlockResponse

Errors

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

getContentBlock

Get Content Blocks

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\MarketingGetContentBlockRequest(
    xAccountId: '<id>',
    id: '<id>',
    fields: 'id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields',
    prefer: 'heartbeat',
);

$response = $sdk->marketing->getContentBlock(
    request: $request
);

if ($response->contentBlockResult !== null) {
    // handle response
}

Parameters

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

Response

?Operations\MarketingGetContentBlockResponse

Errors

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

updateContentBlock

Update Content Block

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$marketingCreateContentBlocksRequestDto = new Components\MarketingCreateContentBlocksRequestDto(
    type: new Components\MarketingCreateContentBlocksRequestDtoType(
        value: Components\MarketingCreateContentBlocksRequestDtoValue::Html,
        sourceValue: 'text',
    ),
    passthrough: [
        'other_known_names' => 'John Doe',
    ],
);

$response = $sdk->marketing->updateContentBlock(
    xAccountId: '<id>',
    id: '<id>',
    marketingCreateContentBlocksRequestDto: $marketingCreateContentBlocksRequestDto,
    prefer: 'heartbeat'

);

if ($response->createResult !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	string	✔️	The account identifier
`id`	string	✔️	N/A
`marketingCreateContentBlocksRequestDto`	Components\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

?Operations\MarketingUpdateContentBlockResponse

Errors

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

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Marketing

Overview

Available Operations

listEmailTemplates

Example Usage

Parameters

Response

Errors

createEmailTemplate

Example Usage

Parameters

Response

Errors

getEmailTemplate

Example Usage

Parameters

Response

Errors

updateEmailTemplate

Example Usage

Parameters

Response

Errors

listInAppTemplates

Example Usage

Parameters

Response

Errors

createInAppTemplate

Example Usage

Parameters

Response

Errors

getInAppTemplate

Example Usage

Parameters

Response

Errors

updateInAppTemplate

Example Usage

Parameters

Response

Errors

listSmsTemplates

Example Usage

Parameters

Response

Errors

createSmsTemplate

Example Usage

Parameters

Response

Errors

getSmsTemplate

Example Usage

Parameters

Response

Errors

updateSmsTemplate

Example Usage

Parameters

Response

Errors

listOmniChannelTemplates

Example Usage

Parameters

Response

Errors

createOmniChannelTemplate

Example Usage

Parameters

Response

Errors

getOmniChannelTemplate