users.setAutoForward()

When do not disturb is enabled, we can use the client.users.setAutoForward() method to assign an auto forward recipient for an organization. The method returns true if the user was successfully set as an auto forward recipient.

We can use client.users.removeAutoForward() to disable the auto forward feature for an organization.

Definition

client.users.setAutoForward(
organizationId: string,
receiverId: string,
):Promise<boolean,Error>

Parameters

ParameterTypeDescription
organizationIdstringOrganization which will receive an auto forward recipient
receiverIdstringUser ID for the auto forward recipient

Example

await client.users.setAutoForward({
organizationId: 'some-organization-id',
receiverId: 'some-user-id'
});