Skip to end of metadata
Go to start of metadata

 

Create a new 'send' group.

Example

Arguments:

 

string $group

the name of the group to be created. Up to 25 alpha-numeric characters, and '-' are allowed. The name cannot consist of only digits.

Returns

an array with 4 keys: 'name', 'numbers', 'id', 'is_stop'

Array key Value
nameString. The name of the group just created
numbers

Integer. The quantity of numbers in the group. Always zero.

idInteger. The unique ID of the group.
is_stop

Boolean. Whether the new group is a stop group. Always false.

Specific error codes:

Code

Meaning

1

A group with that name already exists (group names are not case-sensitive).

2

The group name is invalid. Only up to 25 alpha-numeric characters, and '-' are allowed. The name cannot consist of only digits, at least one alpha character or '-' must be present.

error code 404 is reported if the group does not exist; error code 400 is reported if the group name was not specified. See General error codes

 

 

 

You must know!

Our example code is an illustration of how you might integrate with our systems and is not certified for production environments. You are responsible for testing and QA.