Current section
Files
Jump to
Current section
Files
priv/docs/methods/admin.conversations.setCustomRetention.json
{
"args": {
"channel_id": {
"desc": "The conversation to set the retention policy for.",
"example": "C12345678",
"required": true,
"type": "string"
},
"duration_days": {
"desc": "The message retention duration in days to set for this conversation",
"example": "500",
"required": true,
"type": "integer"
}
},
"desc": "This API endpoint can be used by any admin to set a conversation's retention policy.",
"errors": {
"channel_not_found": "Value given for `channel_id` was invalid.",
"channel_type_not_supported": "Value given for `channel_id` was a group dm, direct message, or #general channel.",
"could_not_set_retention": "The retention policy could not be set.",
"default_org_wide_channel": "The channel given is a default org-wide channel.",
"feature_not_enabled": "The Admin APIs feature is not enabled for this team.",
"invalid_duration": "Retention `duration_days` must be an integer greater than 0 days and less than 36500 days (100 years).",
"not_an_admin": "The token provided is not associated with an admin.",
"restricted_action": "A team preference prevents the authenticated user from modifying the retention policy of this channel.",
"retention_override_not_allowed": "The current retention policy disallows modifying the retention policy of this channel."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.conversations:write",
"url": "https://docs.slack.dev/reference/scopes/admin.conversations.write"
}
]
}
}