UpdateSettings | HeyReach API Documentation

Updates the general settings of a campaign: name, lead list, and exclusion options.

Allowed statuses: DRAFT, SCHEDULED, PAUSED. Returns 400 for any other status (e.g. IN_PROGRESS, FINISHED). If the campaign was SCHEDULED, it reverts to DRAFT.

Important: this is a full replacement of the settings below - every exclusion field you omit from the body will be reset to its default (false for booleans, null for excludeListId). Always send the complete set of exclusion settings you want, not a partial diff.

Body Parameters

campaignId (long, required): The campaign to update.
name (string, required): New campaign name. 1-50 characters.
linkedInUserListId (long, required): Replacement lead list ID. Must be of type USER_LIST. Cannot be changed once the campaign has been started at least once.
excludeContactedFromOtherCampaigns (bool, optional): Default false.
excludeHasOtherAccConversations (bool, optional): Default false.
excludeContactedFromSenderInOtherCampaign (bool, optional): Default false.
excludeListId (long, optional): Must not equal linkedInUserListId.

## Updates the general settings of a campaign: name, lead list, and exclusion options. Allowed statuses: DRAFT, SCHEDULED, PAUSED. Returns 400 for any other status (e.g. IN_PROGRESS, FINISHED). If the campaign was SCHEDULED, it reverts to DRAFT. **Important:** this is a full replacement of the settings below - every exclusion field you omit from the body will be reset to its default (`false` for booleans, `null` for `excludeListId`). Always send the complete set of exclusion settings you want, not a partial diff. ### Body Parameters - **campaignId** _(long, required)_: The campaign to update. - **name** _(string, required)_: New campaign name. 1-50 characters. - **linkedInUserListId** _(long, required)_: Replacement lead list ID. Must be of type USER_LIST. Cannot be changed once the campaign has been started at least once. - **excludeContactedFromOtherCampaigns** _(bool, optional)_: Default `false`. - **excludeHasOtherAccConversations** _(bool, optional)_: Default `false`. - **excludeContactedFromSenderInOtherCampaign** _(bool, optional)_: Default `false`. - **excludeListId** _(long, optional)_: Must not equal `linkedInUserListId`.

Request

This endpoint expects an object.

campaignIdintegerRequired

namestringRequired

linkedInUserListIdintegerRequired

excludeContactedFromOtherCampaignsbooleanRequired

excludeHasOtherAccConversationsbooleanRequired

excludeContactedFromSenderInOtherCampaignbooleanRequired

excludeListIdany or nullOptional

Updates the general settings of a campaign: name, lead list, and exclusion options.

Allowed statuses: DRAFT, SCHEDULED, PAUSED. Returns 400 for any other status (e.g. IN_PROGRESS, FINISHED). If the campaign was SCHEDULED, it reverts to DRAFT.

Body Parameters

campaignId (long, required): The campaign to update.
name (string, required): New campaign name. 1-50 characters.
linkedInUserListId (long, required): Replacement lead list ID. Must be of type USER_LIST. Cannot be changed once the campaign has been started at least once.
excludeContactedFromOtherCampaigns (bool, optional): Default false.
excludeHasOtherAccConversations (bool, optional): Default false.
excludeContactedFromSenderInOtherCampaign (bool, optional): Default false.
excludeListId (long, optional): Must not equal linkedInUserListId.

Updates the general settings of a campaign: name, lead list, and exclusion options.

Body Parameters

Headers

Request

Updates the general settings of a campaign: name, lead list, and exclusion options.

Body Parameters