All Products
Search
Document Center

Chat App Message Service:ArchiveChatappTemplate

Last Updated:Jul 14, 2026

Archives a Chat App Message Service template. Currently, only WhatsApp templates support archiving.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

TemplateList

array<object>

Yes

The template list.

object

Yes

The template list.

TemplateCode

string

Yes

The template code. You can view the template code on the Channel Management > Management > Template Design page.

939938****

Language

string

Yes

The template language. For detailed language codes, see Language codes.

zh_CN

ArchiveType

string

Yes

The archive type.

Valid values:

  • NOT_ARCHIVED :

    NOT_ARCHIVED

  • ARCHIVED :

    ARCHIVED

ARCHIVED

CustSpaceId

string

Yes

The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management page.

示例值示例值

ChannelType

string

Yes

The channel type. Valid values:

  • WHATSAPP.

Note

Only the WhatsApp channel type is supported.

示例值

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

The details about the access denial.

None

Message

string

The error message.

None

RequestId

string

The request ID.

90E63D28-E31D-1EB2-8939-A94866411B2O

Data

object

The returned data.

Message

string

The error message.

示例值示例值

RequestId

string

The request ID.

示例值示例值示例值

Code

string

The request status code.

  • OK indicates that the request was successful.

  • For other error codes, see Error codes.

示例值示例值

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.

  • false: The call failed.

false

Code

string

The request status code.

  • OK indicates that the request was successful.

  • For other error codes, see Error codes.

OK

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.

  • false: The call failed.

true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Message": "示例值示例值",
    "RequestId": "示例值示例值示例值",
    "Code": "示例值示例值",
    "Success": false
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.