Class ProjectSettingsApi

Index

Methods

create delete get update

Methods

create

create(data: CreateProjectSettingsRequestData): Promise<ProjectSettings>
Create Project Settings Creates initial settings for the project. Useful for enabling features like Unified Contact ID. For new projects with no existing contacts, you can enable Unified Contact ID immediately.
Parameters
- data: CreateProjectSettingsRequestData
  The data to provide to the API call.
Returns Promise<ProjectSettings>

delete

delete(data: DeleteProjectSettingsRequestData): Promise<void>
Delete Project Settings Deletes all project-level settings for the specified project.
Parameters
- data: DeleteProjectSettingsRequestData
  The data to provide to the API call.
Returns Promise<void>

get

get(data: GetProjectSettingsRequestData): Promise<ProjectSettings>
Get Project Settings Retrieves the current settings for the specified project, including contact management options such as Unified Contact ID.
Parameters
- data: GetProjectSettingsRequestData
  The data to provide to the API call.
Returns Promise<ProjectSettings>

update

update(data: UpdateProjectSettingsRequestData): Promise<ProjectSettings>
Update Project Settings Updates project settings (e.g. enabling/disabling Unified Contact ID). For existing projects, you must resolve all identity conflicts before enabling Unified Contact ID.
Parameters
- data: UpdateProjectSettingsRequestData
  The data to provide to the API call.
Returns Promise<ProjectSettings>