API Assist - Load

Load Assist Data for Client and Agent

POST /v2/assist/load

Provide as much of Contact array as possible.

Body

Name	Type	Description
access_token	string	Access Token for Agent
contact[unique_id]	string
contact[name]	string
contact[email_address]	email
contact[phone_number]	phone

Response

200

{
    "companyName": "CompanyCo",
    "agent": {
        "id": 1234,
        "name": "Agent",
        "department": "Sales",
        "email_address": "[e-mail]"
    },
    "products": [
        "assist",
        "calls",
        "communication"
    ],
    "communication": [],
    "invalidProducts": [],
    "contact": {
        "id": 1234,
        "unique_id": null,
        "name": "Example",
        "email_address": null,
        "phone_number": "123456789",
        "date_of_birth": null,
        "location": null,
        "biography": null,
        "tags": null,
        "created_at": "2024-10-01T10:52:30.000000Z"
    },
    "buttons": [
        "narrow_down",
        "recommend"
    ],
    "actions": [
        "email",
        "meeting",
        "sms",
        "whatsapp"
    ],
    "subActions": [
        "email_follow_up_email",
        "email_rewrite_email",
        "email_shorten_email",
        "sms_follow_up_sms",
        "sms_rewrite_sms",
        "sms_shorten_sms"
    ],
    "templates": {
        "sms": [
            "Welcome Client",
            "We tried to call you..."
        ],
        "whatsapp": [
            "Welcome Client",
            "We tried to call you..."
        ]
    },
    "calls": []
}

400

{
  "error": "Invalid request"
}