SibApiV3Sdk.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

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.CompaniesApi();
apiInstance.companiesAttributesGet().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

companiesGet

CompaniesList companiesGet(opts)

Get all companies

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.CompaniesApi();

var opts = { 
  'filters': "filters_example", // String | Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"}
  'linkedContactsIds': 789, // Number | Filter by linked contacts ids
  'linkedDealsIds': "linkedDealsIds_example", // String | Filter by linked deals ids
  'page': 789, // Number | Index of the first document of the page
  'limit': 50, // Number | Number of documents per page
  'sort': "sort_example", // String | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
  'sortBy': "sortBy_example" // String | The field used to sort field names.
};
apiInstance.companiesGet(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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	Number	Filter by linked contacts ids	[optional]
linkedDealsIds	String	Filter by linked deals ids	[optional]
page	Number	Index of the first document of the page	[optional]
limit	Number	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

companiesIdDelete

companiesIdDelete(id)

Delete a company

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.CompaniesApi();

var id = "id_example"; // String | 

apiInstance.companiesIdDelete(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

companiesIdGet

Company companiesIdGet(id)

Get a company

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.CompaniesApi();

var id = "id_example"; // String | 

apiInstance.companiesIdGet(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

companiesIdPatch

Company companiesIdPatch(id, body)

Update a company

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.CompaniesApi();

var id = "id_example"; // String | 

var body = new SibApiV3Sdk.Body1(); // Body1 | Updated company details.

apiInstance.companiesIdPatch(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

companiesLinkUnlinkIdPatch

companiesLinkUnlinkIdPatch(id, body)

Link and Unlink company with contacts and deals

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.CompaniesApi();

var id = "id_example"; // String | 

var body = new SibApiV3Sdk.Body2(); // Body2 | Linked / Unlinked contacts and deals ids.

apiInstance.companiesLinkUnlinkIdPatch(id, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

companiesPost

InlineResponse200 companiesPost(body)

Create a company

Example

var SibApiV3Sdk = require('sib-api-v3-sdk');
var defaultClient = SibApiV3Sdk.ApiClient.instance;

// Configure API key authorization: api-key
var apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: partner-key
var partnerKey = defaultClient.authentications['partner-key'];
partnerKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.apiKeyPrefix = 'Token';

var apiInstance = new SibApiV3Sdk.CompaniesApi();

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

apiInstance.companiesPost(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

Files

CompaniesApi.md

Latest commit

History

CompaniesApi.md

File metadata and controls

SibApiV3Sdk.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