Contacts

All PUT endpoints update only the fields present in the body; see Updating Resources.

GET`/v1/contacts`GET /v1/contacts

Code samples

cURL


# You can also use wget
curl -X GET /v1/contacts \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/contacts',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/contacts";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/contacts

Retrieves a list of contacts based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}],"totalContactsCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "contacts": [
    {
      "id": 0,
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "mobile": "string",
      "fax": "string",
      "details": "string",
      "notify": true,
      "customerId": 0,
      "meta": "string"
    }
  ],
  "totalContactsCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetContactsResponse

Authentication: API key (x-api-key).

POST`/v1/contacts`POST /v1/contacts

Code samples

cURL


# You can also use wget
curl -X POST /v1/contacts \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "contact": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "details": "string",
    "notify": true,
    "customerId": 0,
    "meta": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/contacts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/contacts";
      
      string json = @"{
  ""contact"": {
    ""id"": 0,
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""email"": ""string"",
    ""phone"": ""string"",
    ""mobile"": ""string"",
    ""fax"": ""string"",
    ""details"": ""string"",
    ""notify"": true,
    ""customerId"": 0,
    ""meta"": ""string""
  }
}";
      Management.InsertContactRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertContactRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertContactRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/contacts

Inserts a new contact based on the provided request parameters.

Body parameter


{
  "contact": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "details": "string",
    "notify": true,
    "customerId": 0,
    "meta": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.InsertContactRequest	false	The request parameters for inserting a new contact.

Example responses

200 Response


{"contactId":0,"success":true,"code":0,"message":"string"}


{
  "contactId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertContactResponse

Authentication: API key (x-api-key).

PUT`/v1/contacts`PUT /v1/contacts

Code samples

cURL


# You can also use wget
curl -X PUT /v1/contacts \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "contact": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "details": "string",
    "notify": true,
    "customerId": 0,
    "meta": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/contacts',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/contacts";
 
      
      string json = @"{
  ""contact"": {
    ""id"": 0,
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""email"": ""string"",
    ""phone"": ""string"",
    ""mobile"": ""string"",
    ""fax"": ""string"",
    ""details"": ""string"",
    ""notify"": true,
    ""customerId"": 0,
    ""meta"": ""string""
  }
}";
      Management.UpdateContactRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateContactRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateContactRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/contacts

Updates an existing contact based on the provided request parameters.

Body parameter


{
  "contact": {
    "id": 0,
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "details": "string",
    "notify": true,
    "customerId": 0,
    "meta": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	Management.UpdateContactRequest	false	The request parameters for updating a contact.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateContactResponse

Authentication: API key (x-api-key).

DELETE`/v1/contacts/{contactId}`DELETE /v1/contacts/{contactId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/contacts/{contactId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/contacts/{contactId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/contacts/{contactId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/contacts/\{contactId\}

Deletes an existing contact based on the provided request parameters.

Parameters

Name	In	Type	Required	Description
contactId	path	integer(int32)	true	The ID of the contact to delete.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteContactResponse

Authentication: API key (x-api-key).

Contacts

GET/v1/contactsGET /v1/contacts

Code samples

cURL

JavaScript

C#

Parameters

Responses

POST/v1/contactsPOST /v1/contacts

Code samples

cURL

JavaScript

C#

Parameters

Responses

PUT/v1/contactsPUT /v1/contacts

Code samples

cURL

JavaScript

C#

Parameters

Responses

DELETE/v1/contacts/{contactId}DELETE /v1/contacts/{contactId}

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET`/v1/contacts`GET /v1/contacts

POST`/v1/contacts`POST /v1/contacts

PUT`/v1/contacts`PUT /v1/contacts

DELETE`/v1/contacts/{contactId}`DELETE /v1/contacts/{contactId}