Skip to content

Latest commit

 

History

History
157 lines (101 loc) · 5.24 KB

NotesApi.md

File metadata and controls

157 lines (101 loc) · 5.24 KB
Raw

\NotesApi

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

Method HTTP request Description
CrmNotesGet Get /crm/notes Get all notes
CrmNotesIdDelete Delete /crm/notes/{id} Delete a note
CrmNotesIdGet Get /crm/notes/{id} Get a note
CrmNotesIdPatch Patch /crm/notes/{id} Update a note
CrmNotesPost Post /crm/notes Create a note

CrmNotesGet

NoteList CrmNotesGet(ctx, optional) Get all notes

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CrmNotesGetOpts struct

Name Type Description Notes
entity optional.String Filter by note entity type
entityIds optional.String Filter by note entity IDs
dateFrom optional.Int32 dateFrom to date range filter type (timestamp in milliseconds)
dateTo optional.Int32 dateTo to date range filter type (timestamp in milliseconds)
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

Return type

NoteList

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]

CrmNotesIdDelete

CrmNotesIdDelete(ctx, id) Delete a note

Required Parameters

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

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]

CrmNotesIdGet

Note CrmNotesIdGet(ctx, id) Get a note

Required Parameters

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

Return type

Note

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]

CrmNotesIdPatch

CrmNotesIdPatch(ctx, id, body) Update a note

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Note ID to update
body NoteData Note data to update a note

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]

CrmNotesPost

NoteId CrmNotesPost(ctx, body) Create a note

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body NoteData Note data to create a note.

Return type

NoteId

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]