SaveReceiverDetail - Direct Mail - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dm:SaveReceiverDetail

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ReceiverId	string	Yes	The ID of the recipient list.	34642
Detail	string	No	The details of the recipients. You can upload up to 500 recipients at a time. Enclose each recipient's details in braces `{}` and separate them with commas. Example: `[{ },{ },{ }...]`. The format for the details is `[{"b":"birthday","e":"xxx@example.net","g":"gender","m":"mobile","n":"nickname","u":"name"}]`. Pass this value as a string, not an array. If you add a duplicate recipient address, the system returns `"ErrorCount": 1`. If you insert a duplicate recipient address, it will return "ErrorCount": 1.	[{"b":"birthday","e":"xxx@alibaba-inc.com","g":"gender","m":"mobile","n":"nickname","u":"name"}]
CustomDetail	string	No	The recipient's email address and template parameters. This must be in an array format.	[{ "Email": "example@alimail.com","CustomData": {"name":"Tom","age":"30"}}]

Response elements

Element	Type	Description	Example
	object
ErrorCount	integer	The total number of errors.	638
RequestId	string	The request ID.	10A1AD70-E48E-476D-98D9-39BD92193837
SuccessCount	integer	The number of recipients that were successfully added.	274
Data	object
Detail	array<object>	A list of recipient addresses that failed to be added.
	object
Email	string	The recipient address.	test@example.com
ErrMessage	string	The error message.	XXX

Examples

Success response

JSON format

{
  "ErrorCount": 638,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "SuccessCount": 274,
  "Data": {
    "Detail": [
      {
        "Email": "test@example.com",
        "ErrMessage": "XXX"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.