Sign in
Dm channels

Update dm channel

Update the settings of an existing DM channel, such as its display name. Only an admin of the channel can perform this action.

Required permissions (one of):

  • dms:channel:manage
  • support_chat:create
patch/dm_channels/{id}

Path parameters

idstring required

The unique identifier of the DM channel to update.

Request body

custom_namestring nullable

A new custom display name for the DM channel. For example, 'Project Discussion'.

Response

A successful response

created_atstring required

The time the entity was created (in milliseconds since Unix epoch)

idstring required

The unique identifier for the entity

last_message_atstring date-time nullable required

The timestamp when the most recent message was sent in this channel. Null if no messages have been sent.

namestring nullable required

A custom display name assigned to this channel by the user. Null if no custom name has been set.

Example response

{
  "created_at": "123.45",
  "last_message_at": "2023-12-01T05:00:00.401Z",
  "name": "Project Alpha Team"
}

Changes

Changed in 50 of the 74 revisions of this API.100

  • 78e1ed7366cd2See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 73dd0533cd812See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 86b97292852d2See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • c1dceb26e5052See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 7fcefabddb0a2See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99662See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 35edb053220a2See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ac2b9b1c6a002See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • a88353507eac2See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 51933d70d7f52See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

Of the 74 revisions, 1 has no diff computed.