rpaix helprpaix help

AIX.API

home/Documentation/AIX.API
Expand All Collapse All
  • Getting Started
  • Usage
  • Users
    • get-user
    • get-user-by
    • get-user-extra
    • get-user-language
    • get-users
  • Webhooks
    • message-sent
    • email-sent
    • sms-sent
    • new-messages-received
    • bot-message

get-user-by

9 views 0 August 23, 2023 rpaix-chat-team

Searches for a user with the specified user details and returns it.

by

The user detail name. Accepted values: email, first_name, last_name, phone, [extra] (replace [extra] with any user additional detail name).
value
The value of the field.

Response


{
    "id": "881",
    "first_name": "Don",
    "last_name": "John",
    "email": "[email protected]",
    "user_type": "visitor",
    "department": null
 }

Returns {"success":true, "response":false} if the user is not found.

Was this helpful?

Yes  No
Related Articles
  • bot-message
  • new-messages-received
  • sms-sent
  • email-sent
  • message-sent
  • Webhooks

Didn't find your answer? Contact Us

Previously
get-user
Up Next
get-user-extra
© 2023 rpaix.com. All Rights Reserved.