zendesk-messaging-client
    Preparing search index...

    Function syncUser

    • Synchronize User Synchronize a messaging user with its core Zendesk user counterpart. Messaging users are separate objects linked to a core Zendesk user record by zendeskId. It is possible for changes to be made to the core Zendesk user record in a way that causes the messaging user to fall out of sync. The core Zendesk user might have their primary email changed, for example. This endpoint can be used to update the messaging user with the profile.givenName, profile.surname, externalId, and primary email identity of its core Zendesk user counterpart.

      It is also possible for two Zendesk users to be merged. In such a case, this API can be used to apply that merger on the messaging side. The surviving Zendesk user id can be specified via the survivingZendeskId parameter of the request body, and the outgoing zendeskId is specified in the request path.


      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<SyncUserResponses, unknown, ThrowOnError, "fields">