/createAddressGroup

1 min

POST

/createAddressGroup

Calling this request can be used for adding a new address group to the MPC user management so that admins will be able to include this group in the relevant policies.

Request Example:

.. code-block::

createAddressGroup( id="2376234", name="$-Group", contactIds=["contact1", "4

"], request_extra_data={ "MessageNumber": 5, "SessionId": "3478593863424051983840947" } )

Response Example:

.. code-block::

{
    "FunctionData": {
        "StatusCode": 0,
        "StatusCodeDescription": "Address group created successfully"
    },
    "Meta": {
        "AccessToken": "2911...9a7",
        "Destination": "04bc...9e2",
        "Source": "3dcf...ba4",
        "Time": "2025-05-22 17:00:44.605"
    }
}

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	Address group already exists	"StatusCode": 1
Backend Response	400	2	Address group name already exists	"StatusCode": 2
Backend Response	400	3	Invalid address group name	"StatusCode": 3
Backend Response	400	4	Unknown contact	"StatusCode": 4, "ContactIds": ["contact1", "contact2"]
Backend Response	400	5	Duplicate contact	"StatusCode": 5, "ContactId": "1 "
Backend Response	400	8	Contacts have different address group type	"StatusCode": 8

idstringid for the new address group

namestringthe name of the created address group

request_extra_dataobjectadditional data for the administrative request

contact_idsarraydefines the contact list for the new group

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/createAddressGroup?id=2376234&name=MyAddressGroup&request_extra_data=%22None%22&contact_ids=array' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "Id": "2376234",
     "Name": "address group name",
     "RequestExtraData": {
     "MessageNumber": 5,
     "SessionId": "3478593863424051983840947"
     }
     },
     "Meta": {
     "FunctionName": "createAddressGroup",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'