Developer Docs

Table of contents

Edit list

Performs editing of the selected contacts list.

To edit list, make request to this URL:

PUT http://one-api.bsg.world/api/groups/{id} 

Request parameters

ParameterRequiredTypeDescription 
idYesintegerThe unique identifier of the contact list automatically generated by the system when creating the contact list
nameNostringContact list name
descriptionNostringContact list description
defaultNobooleanWhether the contact list is a default one: true or false value

Request sample:

{
  "name": "This is my group",
  "description": "This is my group",
  "default": false
}

Response parameters:

ParameterTypeDescription 
idintegerThe identifier of the contact list automatically generated by the system when creating the contact list
namestringContact list name
descriptionstringContact list description
defaultbooleanIndicates whether the contact list is a default one
created_atdatetimeDate and time when the contact list was created. Display format Y-m-d H:i:s
itemstringThe number of numbers in the contact list.
stop_list_countstringThe number of numbers from the contact list that are in the stop list of SMS and Viber.

If request is successful, you will receive a response:

{
  "data": {
    "id": 1,
    "name": "string",
    "description": "string",
    "default": 0,
    "created_at": "2022-04-28 14:21:16",
    "items": 12,
    "stop_list_count": 0
  }
}