sib_api_v3_sdk.Api.CompaniesApi

All URIs are relative to https://api.sendinblue.com/v3

Method	HTTP request	Description
CompaniesAttributesGet	GET /companies/attributes	Get company attributes
CompaniesGet	GET /companies	Get all companies
CompaniesIdDelete	DELETE /companies/{id}	Delete a company
CompaniesIdGet	GET /companies/{id}	Get a company
CompaniesIdPatch	PATCH /companies/{id}	Update a company
CompaniesLinkUnlinkIdPatch	PATCH /companies/link-unlink/{id}	Link and Unlink company with contacts and deals
CompaniesPost	POST /companies	Create a company

CompaniesAttributesGet

CompanyAttributes CompaniesAttributesGet ()

Get company attributes

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CompaniesAttributesGetExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new CompaniesApi();

            try
            {
                // Get company attributes
                CompanyAttributes result = apiInstance.CompaniesAttributesGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.CompaniesAttributesGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CompanyAttributes

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesGet

CompaniesList CompaniesGet (string filters = null, long? linkedContactsIds = null, string linkedDealsIds = null, long? page = null, long? limit = null, string sort = null, string sortBy = null)

Get all companies

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CompaniesGetExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new CompaniesApi();
            var filters = filters_example;  // string | Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} (optional) 
            var linkedContactsIds = 789;  // long? | Filter by linked contacts ids (optional) 
            var linkedDealsIds = linkedDealsIds_example;  // string | Filter by linked deals ids (optional) 
            var page = 789;  // long? | Index of the first document of the page (optional) 
            var limit = 789;  // long? | Number of documents per page (optional)  (default to 50)
            var sort = sort_example;  // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) 
            var sortBy = sortBy_example;  // string | The field used to sort field names. (optional) 

            try
            {
                // Get all companies
                CompaniesList result = apiInstance.CompaniesGet(filters, linkedContactsIds, linkedDealsIds, page, limit, sort, sortBy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.CompaniesGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
filters	string	Filter by attrbutes. If you have filter for owner on your side please send it as {"attributes.owner":"5b1a17d914b73d35a76ca0c7"}	[optional]
linkedContactsIds	long?	Filter by linked contacts ids	[optional]
linkedDealsIds	string	Filter by linked deals ids	[optional]
page	long?	Index of the first document of the page	[optional]
limit	long?	Number of documents per page	[optional] [default to 50]
sort	string	Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed	[optional]
sortBy	string	The field used to sort field names.	[optional]

Return type

CompaniesList

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesIdDelete

void CompaniesIdDelete (string id)

Delete a company

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CompaniesIdDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new CompaniesApi();
            var id = id_example;  // string | 

            try
            {
                // Delete a company
                apiInstance.CompaniesIdDelete(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.CompaniesIdDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesIdGet

Company CompaniesIdGet (string id)

Get a company

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CompaniesIdGetExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new CompaniesApi();
            var id = id_example;  // string | 

            try
            {
                // Get a company
                Company result = apiInstance.CompaniesIdGet(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.CompaniesIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string

Return type

Company

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesIdPatch

Company CompaniesIdPatch (string id, Body1 body)

Update a company

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CompaniesIdPatchExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new CompaniesApi();
            var id = id_example;  // string | 
            var body = new Body1(); // Body1 | Updated company details.

            try
            {
                // Update a company
                Company result = apiInstance.CompaniesIdPatch(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.CompaniesIdPatch: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string
body	Body1	Updated company details.

Return type

Company

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesLinkUnlinkIdPatch

void CompaniesLinkUnlinkIdPatch (string id, Body2 body)

Link and Unlink company with contacts and deals

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CompaniesLinkUnlinkIdPatchExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new CompaniesApi();
            var id = id_example;  // string | 
            var body = new Body2(); // Body2 | Linked / Unlinked contacts and deals ids.

            try
            {
                // Link and Unlink company with contacts and deals
                apiInstance.CompaniesLinkUnlinkIdPatch(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.CompaniesLinkUnlinkIdPatch: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string
body	Body2	Linked / Unlinked contacts and deals ids.

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompaniesPost

InlineResponse200 CompaniesPost (Body body)

Create a company

Example

using System;
using System.Diagnostics;
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;

namespace Example
{
    public class CompaniesPostExample
    {
        public void main()
        {
            // Configure API key authorization: api-key
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: partner-key
            Configuration.Default.AddApiKey("partner-key", "YOUR_PARTNER_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("partner-key", "Bearer");

            var apiInstance = new CompaniesApi();
            var body = new Body(); // Body | Company create data.

            try
            {
                // Create a company
                InlineResponse200 result = apiInstance.CompaniesPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.CompaniesPost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	Body	Company create data.

Return type

InlineResponse200

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CompaniesApi.md

Latest commit

History

CompaniesApi.md

File metadata and controls

sib_api_v3_sdk.Api.CompaniesApi

CompaniesAttributesGet

Example

Parameters

Return type

Authorization

HTTP request headers

CompaniesGet

Example

Parameters

Return type

Authorization

HTTP request headers

CompaniesIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

CompaniesIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

CompaniesIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

CompaniesLinkUnlinkIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

CompaniesPost

Example

Parameters

Return type

Authorization

HTTP request headers