Salesforce Docs Portal

PUT /messaging/v1/email/seed-list-account

Overview

Update account data for a seed-list. The MID is used from authentication. This method returns the partner list and auto-seed options that are in place for the MID as a result of this transaction. The value for autoSeedThreshold is a positive integer between 1, and 2147483647 (Integer32.Max_Value, or hex 0x7FFFFFFF).

The payload is shortened when setting the autoSeedEnabled setting to false

JSON Parameters

JSON Parameters when setting autoSeedEnabled to true:

Name Type   Description
autoSeedListId string Required A globally unique identifier (GUID).
autoSeedThreshold integer   The threshold for auto-seeding: >= 1 and <= 2147483647. Default value is 10000.
autoSeedEnabled boolean Required A true or false value indicating whether auto-seed is enabled.

JSON Parameters when setting autoSeedEnabled to false:

Name Type   Description
autoSeedEnabled boolean Required A false value to disable auto-seeding.

Response

Status Name Type   Description
200       Successful update of account data, in this instance, to enable auto-seeding.
  autoSeedListId string Required A globally unique identifier (GUID).
  autoSeedThreshold integer   The threshold for auto-seeding: >= 1 and <= 2147483647. Default value is 10000.
  autoSeedEnabled boolean Required A true or false value indicating whether auto-seed is enabled.
200       Successful update of account data, in this case, to disable auto-seeding.
  autoSeedEnabled boolean Required A false value to disable auto-seeding.

Validations:

  • The value of autoSeedEnabled is mandatory. It must have a true or a false value.
  • If autoSeedEnabled is true, autoSeedListId is a mandatory field & can't be empty, nor a default GUID.
  • If autoSeedThreshold isn’t explicitly set, 10000 is set as default.
  • If autoSeedEnabled is false, no other fields must be sent in the input request. In this case, autoSeedListId is set to null, and autoSeedThreshold is set to the default value, 10000.
  • If the partner is disabled but auto-seed has default seed list set to a disabled partner seed-list, this call returns an error.

Validation Failure Scenarios

HTTP Status Description Notes
400 SeedListId is inactive, or non-existent, or there's no mapping of this seedListId for the PartnerAppId. Error code: 30001
400 No active auto-seed-list mapping for the given MID. Error code: 10002/10005, ValidationExceptionInvalidMessageFormat
429 API rate limit throttling is preventing success.

Usage

Example Requests

Setting autoSeedEnabled to true, the validation requires explicit setting of parameter autoSeedListId. The value of autoSeedThreshold must be explicitly set to any value other than the default 10000:

PUT /messaging/v1/email/seed-list-account
{
   "autoSeedlistId":"f21cec40-0227-4e46-8a0e-a4223c0ec1ea",
   "autoSeedThreshold":1000,
   "autoSeedEnabled":true
}

Setting autoSeedEnabled to false, no other fields must be explicitly set. The value of autoSeedListId is set to null, and autoSeedThreshold is set to the default value, 10000.

PUT /messaging/v1/email/seed-list-account  (To disable Auto Seeding)
{
   "autoSeedEnabled":false
}

Example Response

200 OK
{
    "isSuccessful": true
}

Related Items