Class GroupContactsApi

Hierarchy

GroupContactsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GroupContactsApi(basePath?: string): GroupContactsApi

- Defined in api/api.ts:45706
Parameters
- Optional basePath: string
Returns GroupContactsApi

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

marketingGroupsIdContactsContactIdDelete

marketingGroupsIdContactsContactIdDelete(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:45720
Delete Marketing Contact By Id

Parameters
- params: object
  - contactId: number
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

marketingGroupsIdContactsContactIdGet

marketingGroupsIdContactsContactIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MarketingContact>

- Defined in api/api.ts:45763
Get Marketing Contact By Id

Parameters
- params: object
  - contactId: number
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<MarketingContact>

marketingGroupsIdContactsContactIdPatch

marketingGroupsIdContactsContactIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MarketingContact>

- Defined in api/api.ts:45807
Update Marketing Contact

Parameters
- params: object
  - contactId: number
  - id: number
  - operations: Array<PatchOperation>
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<MarketingContact>

marketingGroupsIdContactsContactIdPut

marketingGroupsIdContactsContactIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MarketingContact>

- Defined in api/api.ts:45858
Replace Marketing Contact

Parameters
- params: object
  - contactId: number
  - id: number
  - marketingContact: MarketingContact
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<MarketingContact>

marketingGroupsIdContactsCountGet

marketingGroupsIdContactsCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:45908
Get Marketing Contacts Count

Parameters
- params: object
  - Optional conditions?: string
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

marketingGroupsIdContactsGet

marketingGroupsIdContactsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<MarketingContact>>

- Defined in api/api.ts:45955
Get Marketing Contacts

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - id: number
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<MarketingContact>>

marketingGroupsIdContactsPost

marketingGroupsIdContactsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<MarketingContact>

- Defined in api/api.ts:46017
Create Marketing Contact

Parameters
- params: object
  - id: number
  - marketingContact: MarketingContact
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<MarketingContact>

Generated using TypeDoc