Skip to content

Latest commit

 

History

History
231 lines (147 loc) · 7.68 KB

DealsApi.md

File metadata and controls

231 lines (147 loc) · 7.68 KB
Raw

\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(ctx, ) Get deal attributes

Required 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

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

CrmDealsGet

DealsList CrmDealsGet(ctx, optional) Get all deals

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CrmDealsGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CrmDealsGetOpts struct

Name Type Description Notes
filtersAttributes optional.String Filter by attrbutes. If you have filter for owner on your side please send it as `attributes.owner`."
filtersLinkedCompaniesIds optional.String Filter by linked companies ids
filtersLinkedContactsIds optional.String Filter by linked companies ids
offset optional.Int64 Index of the first document of the page
limit optional.Int64 Number of documents per page [default to 50]
sort optional.String Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed
sortBy optional.String The field used to sort field names.

Return type

DealsList

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]

CrmDealsIdDelete

CrmDealsIdDelete(ctx, id) Delete a deal

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Return type

(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]

CrmDealsIdGet

Deal CrmDealsIdGet(ctx, id) Get a deal

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Return type

Deal

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]

CrmDealsIdPatch

CrmDealsIdPatch(ctx, id, body) Update a deal

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
body Body4 Updated deal details.

Return type

(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]

CrmDealsLinkUnlinkIdPatch

CrmDealsLinkUnlinkIdPatch(ctx, id, body) Link and Unlink a deal with contacts and companies

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
body Body5 Linked / Unlinked contacts and companies ids.

Return type

(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]

CrmDealsPost

InlineResponse201 CrmDealsPost(ctx, body) Create a deal

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Body3 Deal create data.

Return type

InlineResponse201

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]

CrmPipelineDetailsGet

Pipeline CrmPipelineDetailsGet(ctx, ) Get pipeline stages

Required 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

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