Channel Talk icon

Channel Talk

Send messages to Channel Talk

User → Update

AI-generated

Summary

Update a user's information in Channel Talk by specifying their unique User ID and the fields to modify.

Inputs

  • User ID (required) — The unique identifier of the user to update.
  • Update Fields — Fields to update for the user, including whether they are blocked, their profile info, tags, and marketing email/text message subscription status.

Output shape

a single record containing the updated user information

The operation PATCHes to the endpoint /open/v5/users/{userId} with the provided update fields in the request body. The output includes the user's updated data as returned by the Channel Talk API.

Examples

Example 1: Update a user's profile, blocking status, and tags.

Provide the User ID and set any combination of the update fields such as 'blocked' (true/false), 'profileJson' with user details in JSON, 'tagsJson' as a JSON array of tags, and unsubscribe booleans.

Links

Discussion