Contact

List contacts

Use this method to get a list of all existing contacts.

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

Authorization

APIKeyHeader

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/contact?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&group=SOME_INTEGER_VALUE&id=SOME_INTEGER_VALUE&externalId=SOME_STRING_VALUE&phoneNumber=SOME_STRING_VALUE&email=SOME_STRING_VALUE&inArchive=SOME_BOOL_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": [
    {
      "companyName": "Example company",
      "createdAt": "2019-02-01 20:12:12",
      "email": "[e-mail]",
      "externalId": "XXX-XXX-XXX",
      "firstName": "First name",
      "id": "1",
      "lastName": "Last name",
      "phoneNumber": "123123123",
      "externalData": {
        "test": "test",
        "createdAt": "1989-09-28",
        "isClient": false
      },
      "inArchive": "false",
      "unsubscribeAllReason": "Last name",
      "unsubscribeAllTime": "2019-02-01 20:12:12",
      "unsubscribePushTime": "2019-02-01 20:12:12",
      "unsubscribeEmailTime": "2019-02-01 20:12:12",
      "unsubscribeSmsTime": "2019-02-01 20:12:12",
      "isUnsubscribeSms": "false",
      "isUnsubscribeEmail": "false",
      "isUnsubscribePush": "false"
    }
  ]
}

Add contact

Use this method to create a new contact object.

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

Authorization

APIKeyHeader

Body

application/json

any

Response

200207401404500

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/contact");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "[{\"companyName\":\"Example company\",\"createdAt\":\"2019-02-01 20:12:12\",\"email\":\"[e-mail]\",\"externalId\":\"XXX-XXX-XXX\",\"firstName\":\"First name\",\"lastName\":\"Last name\",\"phoneNumber\":\"123123123\",\"externalData\":{\"test\":\"test\",\"createdAt\":\"1989-09-28\",\"isClient\":false},\"addToGroup\":[0]}]", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

200207401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "email": "[e-mail]",
      "externalId": "XXXX-XXXXX-XXXX",
      "id": "123",
      "phoneNumber": "0123123123"
    }
  ]
}

Update contact

Use this method to update details of certain contact.

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

Authorization

APIKeyHeader

Body

application/json

any

Response

200207401404500

Request was successfully processed

Body

application/json

metaobject

Additional data

Request

CsharpGoJavaNodePhpPythonRubyShell

var client = new RestClient("https://api.redlink.pl/v2.1/contact");
var request = new RestRequest(Method.PUT);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "[{\"externalId\":\"bfa0b1b1-e636-b8ab-aba4-78a913be0144\",\"data\":{\"companyName\":\"Example company\",\"email\":\"[e-mail]\",\"externalId\":\"XXX-XXX-XXX\",\"firstName\":\"First name\",\"lastName\":\"Last name\",\"phoneNumber\":\"123123123\",\"externalData\":{\"test\":\"test\",\"createdAt\":\"1989-09-28\",\"isClient\":false}}}]", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

200207401404500

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

Delete contact

Use this method to delete contact.

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

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/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"
  }
}