Class BasicApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo getPage getPageWithHttpInfo merge mergeWithHttpInfo purge purgeWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new BasicApi(configuration, requestFactory?, responseProcessor?): BasicApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: BasicApiRequestFactory
- OptionalresponseProcessor: BasicApiResponseProcessor
Returns BasicApi
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:29

Methods

archiveWithHttpInfo

archiveWithHttpInfo(contactId, _options?): Promise<HttpInfo<void>>
Delete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the data impacted by contact deletions and how to restore archived records. Archive a contact
Parameters
- contactId: string
  The ID of the contact to delete.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:42

create

create(simplePublicObjectInputForCreate, _options?): Promise<SimplePublicObject>
Create a single contact. Include a properties object to define property values for the contact, along with an associations array to define associations with other CRM records. Create a contact
Parameters
- simplePublicObjectInputForCreate: SimplePublicObjectInputForCreate
- Optional_options: PromiseConfigurationOptions
Returns Promise<SimplePublicObject>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:108

createWithHttpInfo

createWithHttpInfo(simplePublicObjectInputForCreate, _options?): Promise<HttpInfo<SimplePublicObject>>
Create a single contact. Include a properties object to define property values for the contact, along with an associations array to define associations with other CRM records. Create a contact
Parameters
- simplePublicObjectInputForCreate: SimplePublicObjectInputForCreate
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SimplePublicObject>>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:86

getById

getById(contactId, properties?, propertiesWithHistory?, associations?, archived?, idProperty?, _options?): Promise<SimplePublicObjectWithAssociations>
Retrieve a contact by its ID (contactId) or by a unique property (idProperty). You can specify what is returned using the properties query parameter. Retrieve a contact
Parameters
- contactId: string
  The ID of the contact to retrieve.
- Optionalproperties: string[]
  A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- OptionalpropertiesWithHistory: string[]
  A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
- Optionalassociations: string[]
  A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- OptionalidProperty: string
  The name of a property whose values are unique for this object type
- Optional_options: PromiseConfigurationOptions
Returns Promise<SimplePublicObjectWithAssociations>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:162

getByIdWithHttpInfo

getByIdWithHttpInfo(contactId, properties?, propertiesWithHistory?, associations?, archived?, idProperty?, _options?): Promise<HttpInfo<SimplePublicObjectWithAssociations>>
Retrieve a contact by its ID (contactId) or by a unique property (idProperty). You can specify what is returned using the properties query parameter. Retrieve a contact
Parameters
- contactId: string
  The ID of the contact to retrieve.
- Optionalproperties: string[]
  A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- OptionalpropertiesWithHistory: string[]
  A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
- Optionalassociations: string[]
  A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- OptionalidProperty: string
  The name of a property whose values are unique for this object type
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SimplePublicObjectWithAssociations>>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:135

getPage

getPage(limit?, after?, properties?, propertiesWithHistory?, associations?, archived?, _options?): Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>
Retrieve all contacts, using query parameters to specify the information that gets returned. Retrieve contacts
Parameters
- Optionallimit: number
  The maximum number of results to display per page.
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionalproperties: string[]
  A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- OptionalpropertiesWithHistory: string[]
  A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
- Optionalassociations: string[]
  A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:216

getPageWithHttpInfo

getPageWithHttpInfo(limit?, after?, properties?, propertiesWithHistory?, associations?, archived?, _options?): Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>
Retrieve all contacts, using query parameters to specify the information that gets returned. Retrieve contacts
Parameters
- Optionallimit: number
  The maximum number of results to display per page.
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionalproperties: string[]
  A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
- OptionalpropertiesWithHistory: string[]
  A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
- Optionalassociations: string[]
  A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:189

merge

merge(publicMergeInput, _options?): Promise<SimplePublicObject>
Merge two contact records. Learn more about merging records. Merge two contacts
Parameters
- publicMergeInput: PublicMergeInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<SimplePublicObject>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:260

mergeWithHttpInfo

mergeWithHttpInfo(publicMergeInput, _options?): Promise<HttpInfo<SimplePublicObject>>
Merge two contact records. Learn more about merging records. Merge two contacts
Parameters
- publicMergeInput: PublicMergeInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SimplePublicObject>>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:238

purge

purge(publicGdprDeleteInput, _options?): Promise<void>
Permanently delete a contact and all associated content to follow GDPR. Use optional property idProperty set to email to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. Learn more about permanently deleting contacts. Permanently delete a contact (GDPR-compliant)
Parameters
- publicGdprDeleteInput: PublicGdprDeleteInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:304

purgeWithHttpInfo

purgeWithHttpInfo(publicGdprDeleteInput, _options?): Promise<HttpInfo<void>>
Permanently delete a contact and all associated content to follow GDPR. Use optional property idProperty set to email to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. Learn more about permanently deleting contacts. Permanently delete a contact (GDPR-compliant)
Parameters
- publicGdprDeleteInput: PublicGdprDeleteInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:282

update

update(contactId, simplePublicObjectInput, idProperty?, _options?): Promise<SimplePublicObject>
Update a contact by ID (contactId) or unique property value (idProperty). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Update a contact
Parameters
- contactId: string
  The ID of the contact to update.
- simplePublicObjectInput: SimplePublicObjectInput
- OptionalidProperty: string
  The name of a property whose values are unique for this object type
- Optional_options: PromiseConfigurationOptions
Returns Promise<SimplePublicObject>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:352

updateWithHttpInfo

updateWithHttpInfo(contactId, simplePublicObjectInput, idProperty?, _options?): Promise<HttpInfo<SimplePublicObject>>
Update a contact by ID (contactId) or unique property value (idProperty). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. Update a contact
Parameters
- contactId: string
  The ID of the contact to update.
- simplePublicObjectInput: SimplePublicObjectInput
- OptionalidProperty: string
  The name of a property whose values are unique for this object type
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SimplePublicObject>>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:328

Class BasicApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BasicApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<SimplePublicObject>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObject>>

getById

Parameters

Returns Promise<SimplePublicObjectWithAssociations>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObjectWithAssociations>>

getPage

Parameters

Returns Promise<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging>>

merge

Parameters

Returns Promise<SimplePublicObject>

mergeWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObject>>

purge

Parameters

Returns Promise<void>

purgeWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

update

Parameters

Returns Promise<SimplePublicObject>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<SimplePublicObject>>

Settings

On This Page