Users

Create a conversation user

post

Creates a new conversation user using either an email or phoneNumber.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Body

application/json

or

or

Responses

201

Successfully created a new conversation user.

application/json

400

User already exists.

application/json

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

post

/external/users

HTTPcURLJavaScriptPython

POST /external/users HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "firstName": "John",
  "lastName": "Doe",
  "context": "Support",
  "source": "webchat",
  "fkUserId": "123456",
  "customData": {
    "key1": "value1",
    "key2": "value2"
  },
  "phoneNumber": "[phone]",
  "email": "[email protected]",
  "fkId": "123456"
}

{
  "id": "5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b",
  "firstName": "John",
  "lastName": "Doe",
  "context": "Support",
  "source": "webchat",
  "fkId": "123456",
  "fkUserId": "123456",
  "email": "[email protected]",
  "phoneNumber": "[phone]",
  "metadata": {
    "customData": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Find user by contact information

get

Retrieves a user by their email, phone number or fkId, along with their conversation IDs for the current agent.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Query parameters

emailstringOptional

User email

Example: [email protected]

phoneNumberstringOptional

User phone number

Example: [phone]

fkIdstringOptional

User fkId

Example: 123456

Responses

200

Successfully retrieved the user and conversation ids

application/json

conversationIdsstring[]Required

Conversation ids

Example: ["5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b","5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b"]

400

Invalid parameters provided.

application/json

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

User not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

get

/external/users/search

HTTPcURLJavaScriptPython

GET /external/users/search HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

{
  "user": {
    "id": "5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b",
    "firstName": "John",
    "lastName": "Doe",
    "context": "Support",
    "source": "webchat",
    "fkId": "123456",
    "fkUserId": "123456",
    "email": "[email protected]",
    "phoneNumber": "[phone]",
    "metadata": {
      "customData": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  },
  "conversationIds": [
    "5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b",
    "5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b"
  ]
}

Get conversation user by ID

get

Retrieves a conversation user by their unique identifier.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Path parameters

idstringRequired

Unique identifier of the conversation user.

Example: 5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b

Responses

200

Successfully retrieved the conversation user.

application/json

idstringRequired

User ID

Example: 5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b

firstNamestringRequired

User first name

Example: John

lastNamestringRequired

User last name

Example: Doe

contextstringOptional

User context

Example: Support

sourcestringOptional

User source

Example: webchat

fkIdstringOptional

User fkId

Example: 123456

fkUserIdstringOptional

User fkUserId

Example: 123456

emailstringOptional

User email

Example: [email protected]

phoneNumberstringOptional

User phone number

Example: [phone]

metadataobjectOptional

Conversation user metadata

Example: {"customData":{"key1":"value1","key2":"value2"}}

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

User not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

get

/external/users/{id}

HTTPcURLJavaScriptPython

GET /external/users/{id} HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

{
  "id": "5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b",
  "firstName": "John",
  "lastName": "Doe",
  "context": "Support",
  "source": "webchat",
  "fkId": "123456",
  "fkUserId": "123456",
  "email": "[email protected]",
  "phoneNumber": "[phone]",
  "metadata": {
    "customData": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Delete conversation user by ID

delete

Delete a conversation user by their unique identifier.

Authorizations

Agent-Secret-Key

Agent-Secret-KeystringRequired

Custom authentication header

Path parameters

idstringRequired

Unique identifier of the conversation user.

Example: 5f7b1b3b-3b3b-4b3b-3b3b-3b3b3b3b3b3b

Responses

204

Successfully delete the conversation user.

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Conversation user not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

delete

/external/users/{id}

HTTPcURLJavaScriptPython

DELETE /external/users/{id} HTTP/1.1
Host: api.raia2.com
Agent-Secret-Key: YOUR_API_KEY
Accept: */*

No content