Group

List groups

Use this method to list all groups.

GEThttps://api.messageflow.com/v2.1/group

Authorization

APIKeyHeader

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

dataarray of all of

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/group?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&orderBy=SOME_STRING_VALUE&orderDirection=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

200401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "id": 1234,
      "name": "test",
      "description": "Test descr",
      "createdAt": 1
    }
  ]
}

Create group

Use this method to create a group that you can use to send email and sms campaigns.

POSThttps://api.messageflow.com/v2.1/group

Authorization

APIKeyHeader

Body

application/json

name*string

The group name.

Example: "test"

descriptionstring

The group description.

Example: "Test descr"

externalIdstring

The unique identifier of the group

Example: "XXXXX-XXXX-XXXX"

Response

200207401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/group");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "[{\"name\":\"test\",\"description\":\"Test descr\",\"externalId\":\"XXXXX-XXXX-XXXX\"}]", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

200207401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  }
}

Update group

Use this method to update a group.

PUThttps://api.messageflow.com/v2.1/group

Authorization

APIKeyHeader

Body

application/json

idinteger

The id of the group.

Example: 1234

namestring

The unique name of the group.

Example: "test"

descriptionstring

The group description.

Example: "Test descr"

Response

200207401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/group");
var request = new RestRequest(Method.PUT);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "[{\"id\":1234,\"name\":\"test\",\"description\":\"Test descr\"}]", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

200207401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  }
}

Delete group

Use this method to delete an existing group.

DELETEhttps://api.messageflow.com/v2.1/group

Authorization

APIKeyHeader

Body

application/json

id*array of integer

The id of a object

Response

200207401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/group");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"id\":[1]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

200207401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  }
}