Skip to main content

Interface: ConfigureDocumoFaxRequest

Defined in: packages/sdk/src/types/generated/documo_fax.ts:9

Properties

apiKey?

optional apiKey: string | null

Defined in: packages/sdk/src/types/generated/documo_fax.ts:11

Documo API key. Write-only; omit to leave unchanged.


baseUrl?

optional baseUrl: string | null

Defined in: packages/sdk/src/types/generated/documo_fax.ts:13

Documo API base URL (production or sandbox)


defaultWorkflowId?

optional defaultWorkflowId: number | null

Defined in: packages/sdk/src/types/generated/documo_fax.ts:17

Run this workflow on every received fax. Executes directly, the way a phone number's workflow does; no rule is written.


enabled?

optional enabled: boolean | null

Defined in: packages/sdk/src/types/generated/documo_fax.ts:22


inboxFolderId?

optional inboxFolderId: number | null

Defined in: packages/sdk/src/types/generated/documo_fax.ts:21

Folder received faxes are filed in. Must already exist; send an explicit null to clear it.


ownerMemberId?

optional ownerMemberId: number | null

Defined in: packages/sdk/src/types/generated/documo_fax.ts:15

Agent or Member received faxes are owned by


processingInstructions?

optional processingInstructions: string | null

Defined in: packages/sdk/src/types/generated/documo_fax.ts:19

First message to the agent when the workflow runs