---
title: /createAddressGroup
slug: createaddressgroup
createdAt: 2024-01-09T12:30:00.560Z
---

{
  "id": "IgfjJFhiNTM84XOj74m7S",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "http://1.1.1.1/createAddressGroup",
    "servers": [
      {
        "url": "http://1.1.1.1/createAddressGroup"
      }
    ],
    "name": "",
    "description": "<ul>\n<li>\n<p>NOTE - this function can not be called from Swagger, please use createAddressGroupForSwagger instead.</p>\n</li>\n<li>\n<p>Calling this request can be used for adding a new address group to the MPC user management</p>\n</li>\n<li>\n<p>return - success or error response.</p>\n</li>\n<li>\n<p>Possible status codes:</p>\n</li>\n</ul>\n<p>0 - Address group created successfully,</p>\n<p>1 - Address group already exists,</p>\n<p>2 - Address group name already exists,</p>\n<p>3 - Invalid address group name,</p>\n<p>4 - Unknown contact,</p>\n<p>5 - Duplicate contact</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "required",
          "name": "id",
          "type": "string",
          "example": "2376234",
          "description": "id for the new address group",
          "default": "2376234"
        },
        {
          "kind": "required",
          "name": "name",
          "type": "string",
          "example": "MyAddressGroup",
          "description": "the name of the created address group",
          "default": "MyAddressGroup"
        },
        {
          "kind": "required",
          "name": "request_extra_data",
          "type": "object",
          "example": "",
          "description": "additional data for the administrative request",
          "default": "{\n  \"MessageNumber\": 5,\n  \"SessionId\": \"3478593863424051983840947\"\n}\n",
          "schema": []
        },
        {
          "kind": "required",
          "name": "contact_ids",
          "type": "array",
          "description": "defines the contact list for the new group",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        }
      ],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "customType": "createAddressGroupRequest",
          "schema": [
            {
              "name": "FunctionData",
              "kind": "optional",
              "type": "object",
              "example": "",
              "schema": [
                {
                  "name": "Id",
                  "kind": "optional",
                  "type": "string",
                  "description": "Random UUID generated by the client",
                  "example": "2376234",
                  "default": "2376234"
                },
                {
                  "name": "Name",
                  "kind": "optional",
                  "type": "string",
                  "description": "Name of the address group",
                  "example": "address group name",
                  "default": "address group name"
                },
                {
                  "name": "ContactIds",
                  "kind": "optional",
                  "type": "array",
                  "description": "List of contact IDs associated with the address group",
                  "example": "[\"contact1\",\"contact2\"]",
                  "itemType": "string",
                  "customType": "string[]",
                  "itemExample": "",
                  "itemDefault": ""
                },
                {
                  "name": "RequestExtraData",
                  "kind": "optional",
                  "type": "object",
                  "description": "Additional data for the request",
                  "example": "",
                  "schema": [
                    {
                      "name": "MessageNumber",
                      "kind": "optional",
                      "type": "integer",
                      "description": "Message number",
                      "example": 5,
                      "default": 5
                    },
                    {
                      "name": "SessionId",
                      "kind": "optional",
                      "type": "string",
                      "description": "Session ID",
                      "example": "3478593863424051983840947",
                      "default": "3478593863424051983840947"
                    }
                  ]
                }
              ]
            },
            {
              "name": "Meta",
              "kind": "optional",
              "type": "object",
              "modelRef": "#/components/schemas/MetaTokencreateAddressGroup",
              "customType": "MetaTokencreateAddressGroup",
              "schema": [
                {
                  "name": "FunctionName",
                  "kind": "optional",
                  "type": "string",
                  "description": "The Function to be called",
                  "example": "createAddressGroup",
                  "default": "createAddressGroup"
                },
                {
                  "name": "RandomData",
                  "kind": "optional",
                  "type": "string",
                  "description": "Random Data",
                  "example": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
                  "default": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229"
                },
                {
                  "name": "Destination",
                  "kind": "optional",
                  "type": "string",
                  "description": "Id of the server",
                  "example": "",
                  "default": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea"
                },
                {
                  "name": "Time",
                  "kind": "optional",
                  "type": "string",
                  "description": "UTC Time of execution",
                  "example": "2021-02-07T18:37:46.948Z",
                  "default": "2021-02-07T18:37:46.948Z"
                },
                {
                  "name": "Source",
                  "kind": "optional",
                  "type": "string",
                  "description": "User public key",
                  "example": "",
                  "default": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99"
                },
                {
                  "name": "AccessToken",
                  "kind": "optional",
                  "type": "string",
                  "description": "Token used for authentication purposes",
                  "example": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087",
                  "default": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
                }
              ]
            }
          ],
          "modelRef": "#/components/schemas/createAddressGroupRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "success",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "customType": "createAddressGroupResponse",
            "schema": [
              {
                "name": "FunctionData",
                "kind": "optional",
                "type": "object",
                "example": "",
                "schema": [
                  {
                    "name": "StatusCode",
                    "kind": "optional",
                    "type": "integer",
                    "description": "Status code for the current run",
                    "example": 0,
                    "default": 0
                  }
                ]
              },
              {
                "name": "Meta",
                "kind": "optional",
                "type": "object",
                "modelRef": "#/components/schemas/MetaResponse",
                "customType": "MetaResponse",
                "schema": [
                  {
                    "name": "AccessToken",
                    "kind": "optional",
                    "type": "string",
                    "description": "The new access token generated after this operation",
                    "example": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
                    "default": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6"
                  },
                  {
                    "name": "Destination",
                    "kind": "optional",
                    "type": "string",
                    "description": "Id of the server",
                    "example": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
                    "default": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622"
                  },
                  {
                    "name": "Source",
                    "kind": "optional",
                    "type": "string",
                    "description": "User public key",
                    "example": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
                    "default": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355"
                  },
                  {
                    "name": "Time",
                    "kind": "optional",
                    "type": "string",
                    "description": "UTC Time of execution",
                    "example": "2021-02-14 09:58:52.320",
                    "default": "2021-02-14 09:58:52.320"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/createAddressGroupResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url 'http://1.1.1.1/createAddressGroup?id=2376234&name=MyAddressGroup&request_extra_data=%22{%5Cn%20%20%5C%22MessageNumber%5C%22%3A%205%2C%5Cn%20%20%5C%22SessionId%5C%22%3A%20%5C%223478593863424051983840947%5C%22%5Cn}%5Cn%22&contact_ids=array' \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"FunctionData\": {\n     \"Id\": \"2376234\",\n     \"Name\": \"address group name\",\n     \"RequestExtraData\": {\n     \"MessageNumber\": 5,\n     \"SessionId\": \"3478593863424051983840947\"\n     }\n     },\n     \"Meta\": {\n     \"FunctionName\": \"createAddressGroup\",\n     \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n     \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n     \"Time\": \"2021-02-07T18:37:46.948Z\",\n     \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n     \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n     }\n     }'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"FunctionData\": {\n      \"Id\": \"2376234\",\n      \"Name\": \"address group name\",\n      \"RequestExtraData\": {\n         \"MessageNumber\": 5,\n         \"SessionId\": \"3478593863424051983840947\"\n      }\n   },\n   \"Meta\": {\n      \"FunctionName\": \"createAddressGroup\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"http://1.1.1.1/createAddressGroup?id=2376234&name=MyAddressGroup&request_extra_data=\\\"{\\\\n  \\\\\\\"MessageNumber\\\\\\\": 5,\\\\n  \\\\\\\"SessionId\\\\\\\": \\\\\\\"3478593863424051983840947\\\\\\\"\\\\n}\\\\n\\\"&contact_ids=array\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://1.1.1.1/createAddressGroup?id=2376234&name=MyAddressGroup&request_extra_data=\\\"{\\n  \\\\\"MessageNumber\\\\\": 5,\\n  \\\\\"SessionId\\\\\": \\\\\"3478593863424051983840947\\\\\"\\n}\\n\\\"&contact_ids=array\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"FunctionData\": {\n      \"Id\": \"2376234\",\n      \"Name\": \"address group name\",\n      \"RequestExtraData\": {\n         \"MessageNumber\": 5,\n         \"SessionId\": \"3478593863424051983840947\"\n      }\n   },\n   \"Meta\": {\n      \"FunctionName\": \"createAddressGroup\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"http://1.1.1.1/createAddressGroup?id=2376234&name=MyAddressGroup&request_extra_data=\\\"{\\\\n  \\\\\\\"MessageNumber\\\\\\\": 5,\\\\n  \\\\\\\"SessionId\\\\\\\": \\\\\\\"3478593863424051983840947\\\\\\\"\\\\n}\\\\n\\\"&contact_ids=array\"\n\npayload = json.dumps({\n   \"FunctionData\": {\n      \"Id\": \"2376234\",\n      \"Name\": \"address group name\",\n      \"RequestExtraData\": {\n         \"MessageNumber\": 5,\n         \"SessionId\": \"3478593863424051983840947\"\n      }\n   },\n   \"Meta\": {\n      \"FunctionName\": \"createAddressGroup\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// success\n{\n  \"FunctionData\": {\n    \"StatusCode\": 0\n  },\n  \"Meta\": {\n    \"AccessToken\": \"a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6\",\n    \"Destination\": \"042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622\",\n    \"Source\": \"df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355\",\n    \"Time\": \"2021-02-14 09:58:52.320\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "Qf04p0lmPvjc61UQqjB-Q",
      "type": "bulleted-list",
      "children": [
        {
          "id": "uXI0COa-SQ1pZ2vFBSybj",
          "type": "list-item",
          "children": [
            {
              "id": "aOck6w28ulGCpoLxvAxYl",
              "type": "list-item-child",
              "children": [
                {
                  "text": "NOTE - this function can not be called from Swagger, please use createAddressGroupForSwagger instead.",
                  "id": "G9ydZqslI3fAIlkZ1jlfh"
                }
              ]
            }
          ]
        },
        {
          "id": "6G1YAFIEBwY_7ZLFO-xsL",
          "type": "list-item",
          "children": [
            {
              "id": "EUTw8eqfhM5jnyV1f5s5a",
              "type": "list-item-child",
              "children": [
                {
                  "text": "Calling this request can be used for adding a new address group to the MPC user management",
                  "id": "SqsaD2rQGlw4Hu5NbR_nn"
                }
              ]
            }
          ]
        },
        {
          "id": "hTH148VJXE2JM62iPQnDD",
          "type": "list-item",
          "children": [
            {
              "id": "YtKHAyWdd5MufqfDhqfxk",
              "type": "list-item-child",
              "children": [
                {
                  "text": "return - success or error response.",
                  "id": "QNHjHRZyiBlQu3MDhk1JJ"
                }
              ]
            }
          ]
        },
        {
          "id": "rY2Xb8Mo1H52hOYfhBvh5",
          "type": "list-item",
          "children": [
            {
              "id": "17Lf6RorZE23C5Zbaj1dK",
              "type": "list-item-child",
              "children": [
                {
                  "text": "Possible status codes:",
                  "id": "0p_Z09NBrOMN6oa9_J8wv"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "lELrZCqol2FKsndgy2dEr",
      "type": "paragraph",
      "children": [
        {
          "text": "0 - Address group created successfully,",
          "id": "AU4FkB0evN-n7ucHJt7T4"
        }
      ]
    },
    {
      "id": "aXl8SlzDh7wgRlpRb1q72",
      "type": "paragraph",
      "children": [
        {
          "text": "1 - Address group already exists,",
          "id": "K6YCypF39FNThjhPhecBQ"
        }
      ]
    },
    {
      "id": "iccLQbW12QnTLhcYmZ0R7",
      "type": "paragraph",
      "children": [
        {
          "text": "2 - Address group name already exists,",
          "id": "3OjRe38-y7rjDlAGXkSJK"
        }
      ]
    },
    {
      "id": "vx_3Y-N5EIWNY_VrJNdZ_",
      "type": "paragraph",
      "children": [
        {
          "text": "3 - Invalid address group name,",
          "id": "YPfUJgGtDCEl1BmC-N4W5"
        }
      ]
    },
    {
      "id": "6IKbwoQsqlYIUCcZRf2u5",
      "type": "paragraph",
      "children": [
        {
          "text": "4 - Unknown contact,",
          "id": "jBh8Y1LRs6MABYQOYGm-X"
        }
      ]
    },
    {
      "id": "ovdXslOqKLUZVPQH1WNzf",
      "type": "paragraph",
      "children": [
        {
          "text": "5 - Duplicate contact",
          "id": "PBGJiSf_p0kgWMj2IateC"
        }
      ]
    }
  ]
}