JSON API » outgroups » outgroups/create

Creates a new outbound group.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringName.Yes
descriptionStringDescription.NoEmpty string.
includedInteger1 if calls to this outbound group counts towards included call time, 0 if not.No0
name_invoicesStringName as shown on invoices. Empty string to use name.NoEmpty string.
tagsStringTags.NoEmpty string.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
200Success.
201Input passed validation. Only returned if validation=1.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.

Data returned

The ID of the created outbound group.

Example: With required parameters

http://enswitch.example.com/api/json/outgroups/create/?auth_username=user;auth_password=password;name=example

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

VersionChanges
3.13Function added.