Contact

List contacts in group

Use this method to list all contacts in a group.

GEThttps://api.messageflow.com/v2.1/group/{groupId}/contact

Authorization

APIKeyHeader

Path parameters

groupId*string

The group id that should be searched

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

dataarray of object

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/group/%7BgroupId%7D/contact?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": [
    {
      "email": "[e-mail]",
      "externalId": "XXXX-XXXXX-XXXX",
      "id": "123",
      "phoneNumber": "0123123123"
    }
  ]
}

Add contacts to group

Use this method to add contacts to a group.

POSThttps://api.messageflow.com/v2.1/group/{groupId}/contact

Authorization

APIKeyHeader

Path parameters

groupId*int

The id of the group.

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/%7BgroupId%7D/contact");
var request = new RestRequest(Method.POST);
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"
  }
}

Delete contacts from group

Use this method to delete contacts from a group.

DELETEhttps://api.messageflow.com/v2.1/group/{groupId}/contact

Authorization

APIKeyHeader

Path parameters

groupId*int

The id of the group.

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/%7BgroupId%7D/contact");
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"
  }
}