Skip to content

Latest commit

 

History

History
334 lines (218 loc) · 11.3 KB

CRMApi.md

File metadata and controls

334 lines (218 loc) · 11.3 KB
Raw

\CRMApi

All URIs are relative to https://api.sendinblue.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
CrmTasksGet Get /crm/tasks Get all tasks
CrmTasksIdDelete Delete /crm/tasks/{id} Delete a task
CrmTasksIdGet Get /crm/tasks/{id} Get a task
CrmTasksIdPatch Patch /crm/tasks/{id} Update a task
CrmTasksPost Post /crm/tasks Create a task
CrmTasktypesGet Get /crm/tasktypes Get all task types

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]

CrmTasksGet

TaskList CrmTasksGet(ctx, optional) Get all tasks

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CrmTasksGetOpts struct

Name Type Description Notes
filterType optional.String Filter by task type (ID)
filterStatus optional.String Filter by task status
filterDate optional.String Filter by date
filterAssignTo optional.String Filter by assignTo id
filterContacts optional.String Filter by contact ids
filterDeals optional.String Filter by deals ids
filterCompanies optional.String Filter by companies 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
sortBy optional.String The field used to sort field names.

Return type

TaskList

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]

CrmTasksIdDelete

CrmTasksIdDelete(ctx, id) Delete a task

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]

CrmTasksIdGet

Task CrmTasksIdGet(ctx, id) Get a task

Required Parameters

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

Return type

Task

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]

CrmTasksIdPatch

CrmTasksIdPatch(ctx, id, body) Update a task

Required Parameters

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

CrmTasksPost

InlineResponse2011 CrmTasksPost(ctx, body) Create a task

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Body5 Task name.

Return type

InlineResponse2011

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]

CrmTasktypesGet

TaskTypes CrmTasktypesGet(ctx, ) Get all task types

Required Parameters

This endpoint does not need any parameter.

Return type

TaskTypes

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]