Reamaze PHP SDK
Back to top  

CreateParams

Extends \mixisLv\Reamaze\Params\BaseParams

Class CreateParams

package

mixisLv\Reamaze\Params\Conversations
see

Methods

BaseParams constructor.

__construct(array $params = array())
inherited
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$params

array

__get

__get( $property) : mixed
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$property

Response

mixed

__set

__set( $property,  $value)
inherited
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$property

$value

paramsArray

paramsArray() : array
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Response

array

sanitizePage

sanitizePage( $value) : integer
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

$value

Response

integer

toArray

toArray()
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Properties

conversation subject

subject : string
var

conversation subject

Type(s)

string

The category attribute should be set to the slug of the Channel where this Conversation should be created.

category : string

The slug is the alphanumeric identifier for a Channel in Reamaze provided by the part before the @ in the Channel Email Address.

var

conversation category

Type(s)

string

You can optionally pass in a tag_list array of strings to tag the conversation.

tagList : array
var

conversation tags

Type(s)

array

array['message'] ['body'] string message body [recipients] array (optional) list of additional participants in the conversation [user] array conversation author [name] string conversation author name [email] string conversation author email [suppress_notification] boolean (optional)

message : array

You can optionally pass in a message[recipients] array attribute as part of the conversation to pass in additional participants in the conversation. These participants will be automatically added as recipients in future correspondences within the thread. You can optionally pass in a message[suppress_notification] boolean attribute with a value of true to prevent Reamaze from sending any email (or integration) notifications related to this message

var

conversation message (See above)

Type(s)

array

conversation user

user : array
var

conversation user

Type(s)

array

You can optionally pass in a data hash attribute as part of the conversation to pass in custom field attributes for the conversation.

data : array
var

custom attributes

Type(s)

array