Skip to content

Latest commit

 

History

History
208 lines (133 loc) · 7.14 KB

CompaniesApi.md

File metadata and controls

208 lines (133 loc) · 7.14 KB
Raw

\CompaniesApi

All URIs are relative to https://api.brevo.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(ctx, ) Get company attributes

Required 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(ctx, optional) Get all companies

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CompaniesGetOpts struct

Name Type Description Notes
filters optional.String Filter by attrbutes. If you have filter for owner on your side please send it as {"attributes.owner":"5b1a17d914b73d35a76ca0c7"}
linkedContactsIds optional.Int64 Filter by linked contacts ids
linkedDealsIds optional.String Filter by linked deals ids
page 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

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

CompaniesIdDelete(ctx, id) Delete a company

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]

CompaniesIdGet

Company CompaniesIdGet(ctx, id) Get a company

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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(ctx, id, body) Update a company

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
body Body6 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

CompaniesLinkUnlinkIdPatch(ctx, id, body) Link and Unlink company with contacts and deals

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
body Body7 Linked / Unlinked contacts and deals 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]

CompaniesPost

InlineResponse2002 CompaniesPost(ctx, body) Create a company

Required Parameters

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

Return type

InlineResponse2002

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]