SibApiV3Sdk.DealsApi

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

Method	HTTP request	Description
crmAttributesDealsGet	GET /crm/attributes/deals	Get deal attributes
crmDealsGet	GET /crm/deals	Get all deals
crmDealsIdDelete	DELETE /crm/deals/{id}	Delete a deal
crmDealsIdGet	GET /crm/deals/{id}	Get a deal
crmDealsIdPatch	PATCH /crm/deals/{id}	Update a deal
crmDealsLinkUnlinkIdPatch	PATCH /crm/deals/link-unlink/{id}	Link and Unlink a deal with contacts and companies
crmDealsPost	POST /crm/deals	Create a deal
crmPipelineDetailsGet	GET /crm/pipeline/details	Get pipeline stages

crmAttributesDealsGet

DealAttributes crmAttributesDealsGet()

Get deal 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.DealsApi();
apiInstance.crmAttributesDealsGet().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

DealAttributes

Authorization

api-key, partner-key

HTTP request headers

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

crmDealsGet

DealsList crmDealsGet(opts)

Get all 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.DealsApi();

var opts = { 
  'filtersAttributes': "filtersAttributes_example", // String | Filter by attrbutes. If you have filter for owner on your side please send it as `attributes.owner`.\"
  'filtersLinkedCompaniesIds': "filtersLinkedCompaniesIds_example", // String | Filter by linked companies ids
  'filtersLinkedContactsIds': "filtersLinkedContactsIds_example", // String | Filter by linked companies ids
  'offset': 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.crmDealsGet(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
filtersAttributes	String	Filter by attrbutes. If you have filter for owner on your side please send it as `attributes.owner`."	[optional]
filtersLinkedCompaniesIds	String	Filter by linked companies ids	[optional]
filtersLinkedContactsIds	String	Filter by linked companies ids	[optional]
offset	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

DealsList

Authorization

api-key, partner-key

HTTP request headers

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

crmDealsIdDelete

crmDealsIdDelete(id)

Delete a deal

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.DealsApi();

var id = "id_example"; // String | 

apiInstance.crmDealsIdDelete(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

crmDealsIdGet

Deal crmDealsIdGet(id)

Get a deal

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.DealsApi();

var id = "id_example"; // String | 

apiInstance.crmDealsIdGet(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

Deal

Authorization

api-key, partner-key

HTTP request headers

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

crmDealsIdPatch

crmDealsIdPatch(id, body)

Update a deal

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.DealsApi();

var id = "id_example"; // String | 

var body = new SibApiV3Sdk.Body4(); // Body4 | Updated deal details.

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

Parameters

Name	Type	Description	Notes
id	String
body	Body4	Updated deal details.

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

crmDealsLinkUnlinkIdPatch

crmDealsLinkUnlinkIdPatch(id, body)

Link and Unlink a deal with contacts and 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.DealsApi();

var id = "id_example"; // String | 

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

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

Parameters

Name	Type	Description	Notes
id	String
body	Body5	Linked / Unlinked contacts and companies ids.

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

crmDealsPost

InlineResponse201 crmDealsPost(body)

Create a deal

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.DealsApi();

var body = new SibApiV3Sdk.Body3(); // Body3 | Deal create data.

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

Parameters

Name	Type	Description	Notes
body	Body3	Deal create data.

Return type

InlineResponse201

Authorization

api-key, partner-key

HTTP request headers

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

crmPipelineDetailsGet

Pipeline crmPipelineDetailsGet()

Get pipeline stages

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.DealsApi();
apiInstance.crmPipelineDetailsGet().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

Pipeline

Authorization

api-key, partner-key

HTTP request headers

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

Files

DealsApi.md

Latest commit

History

DealsApi.md

File metadata and controls

SibApiV3Sdk.DealsApi

crmAttributesDealsGet

Example

Parameters

Return type

Authorization

HTTP request headers

crmDealsGet

Example

Parameters

Return type

Authorization

HTTP request headers

crmDealsIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

crmDealsIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

crmDealsIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

crmDealsLinkUnlinkIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

crmDealsPost

Example

Parameters

Return type

Authorization

HTTP request headers

crmPipelineDetailsGet

Example

Parameters

Return type

Authorization

HTTP request headers