JSON

• Removing, renaming, or moving API entities.

• Changing or removing functionality.

• Making optional parameters or properties mandatory.

• Limit maximum amount of conversations returned for GET request to the conversation list endpoint (/api/um/v3/conversations/) to 10,000

• Limit maximum amount of contacts returned for GET request to the contact list endpoint (/api/um/v3/contact_identities/) to 10,000

• Add new conversation all endpoint (/api/um/v3/conversations/all/) with cursor-based pagination that has no limit on the number of returned conversations

• Add new contact all endpoint (/api/um/v3/contact_identities/all/) with cursor-based pagination that has no limit on the number of returned contacts

• Change PATCH request schema for single endpoints. You can now pass data directly without wrapping it in '{"update: {..}}"'.

• Remove option to update operator away status on the single endpoint. There now is a new endpoint to do that: /api/um/v3/operators/{id}/away/

javascript
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header  "Userlike-Organization-Id: 3" \
     "https://api.userlike.com/api/um/v3/conversations/"

bash
# provide content-type header 'application/json' for POST requests
curl --request POST \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/notes/" \
     --data '{"contact_identity_id": 50670, "body": "Is highly interested in our new product."}'

# result is the created resource item
{created resource item}


# provide content-type header 'application/json' for PATCH requests
curl --request PATCH \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/conversations/{id}/" \
     --data '{"topics":["Support"]}'

# result is the updated resource item
{patched resource item}



# otherwise request body cannot be processed
curl --request PATCH
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/{id}/" \
     --data '{"topics":["Support"]}'

bash
# provide a different operator to use in request
curl --request DELETE \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Userlike-Operator-Id: 152" \
     "https://api.userlike.com/api/um/v3/operators/150/" \

# provided operator lacks capability to delete operators
{
    "detail":"You do not have permission to perform this action."
}

# running the same request with the default operator (owner)
curl --request DELETE \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/operators/150/" \

# operator was successfully deleted
HTTP/1.1 204 No Content

bash
# adds to default organization's conversation resource count
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/"

# adds to other organization's conversation resource count
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Userlike-Organization-Id: 3" \
     "https://api.userlike.com/api/um/v3/conversations/"

# adds to default organization's contact resource count
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/"

bash
# GET list endpoint adds to organization's conversation resource count
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/"

# GET single endpoint adds to organization's conversation resource count
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/{id}/"

# PATCH single endpoint adds to organization's conversation resource count
curl --request PATCH  \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/conversations/{id}/" \
     --data '{"topics":["Support"]}'

bash
# GET without parameters to conversations list endpoint
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/"

# result JSON - we are on page 1, so we only have a 'next' link
{
    "count": 63,
    "next": "https://api.userlike.com/api/um/v3/conversations/?limit=10&offset=10",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# GET call using the next link provided in first call
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?limit=10&offset=10"

# result JSON - we are now on page 2 and have previous and next link
{
    "count": 63,
    "next": "https://api.userlike.com/api/um/v3/conversations/?limit=10&offset=20",
    "previous": "https://api.userlike.com/api/um/v3/conversations/?limit=10",
    "results": [
        {conversation object},
        ...
    ]
}

bash
# GET call using a custom limit
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?limit=5"

# result JSON with first 5 items - the offset has been automatically adjusted
{
    "count": 63,
    "next": "https://api.userlike.com/api/um/v3/conversations/?limit=5&offset=5",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# GET call using a custom limit and offset
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?limit=5&offset=7"

# result JSON with items 8 - 12 - previous and next links are adjusted
{
    "count": 63,
    "next": "https://api.userlike.com/api/um/v3/conversations/?limit=5&offset=12",
    "previous": "https://api.userlike.com/api/um/v3/conversations/?limit=5&offset=2",
    "results": [
        {conversation object},
        ...
    ]
}

bash
# get messages after message with reference "2015.2508.14032"
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversation/123/messages/?ordering=id&cursor=2015.2508.14032&limit=50"

# JSON data with results array and pagination info
# you will automatically get a link to access the 50 messages that come after the latest results in
# "next" and a link to access the 50 results that come before the first result in "previous"
{
    "next": "https://api.userlike.com/api/um/v3/conversation/123/messages/?cursor=2015.2508.14082&limit=50",
    "previous": "https://api.userlike.com/api/um/v3/conversation/123/messages/?cursor=-2015.2508.13900&limit=50",
    "results": [...]
}

bash
# order all contacts by email (ascending) instead of ID
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/?ordering=email"

# results 1-10, sorted by email (ascending)
{
    "count": 14,
    "next": "https://api.userlike.com/api/um/v3/contact_identities/?limit=10&offset=10&ordering=email",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

# order all contacts by email (descending) instead of ID
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/?ordering=-email"

# results 1-10, sorted by email (descending)
{
    "count": 14,
    "next": "https://api.userlike.com/api/um/v3/contact_identities/?limit=10&offset=10&ordering=-email",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# filter all conversations for a certain operator
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?operator_id=154"

# filtered results 1-10, with operator filter in 'next' link
{
    "count": 30,
    "next": "https://api.userlike.com/api/um/v3/conversations/?limit=10&offset=10&operator_id=154",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# filter all conversations for a certain operator and a certain contact
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?operator_id=154&contact_uuid=MGEwYWJmZmEtN2M1OS01NGI2LWE2OWYtZWYxNDY4OWM0YWQ3"

# filtered results 1-10 that match both operator and contact
{
    "count": 10,
    "next": null,
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# filter all conversations for a certain operator and a certain contact and a certain chat widget
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?operator_id=154&contact_uuid=MGEwYWJmZmEtN2M1OS01NGI2LWE2OWYtZWYxNDY4OWM0YWQ3&chat_widget_id=3"

# empty result set
{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}

bash
# get all conversations assigned to the provided Operator
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?operator_id=16?limit=100"

# results 1-100 of conversations for specific Operator
{
    "count": 4,
    "next": null,
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

# extract Ids from results
# provide extracted Ids as comma-separated string, as 'exclude_ids'value
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?exclude_ids=22,34,678,59"

# results 1-10 of all conversations that are not assigned to the Operator
{
    "count": 230,
    "next": "https://api.userlike.com/api/um/v3/conversations/?exclude_ids=22%2C134%2C678%2C59&limit=10&offset=10",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# delete these specific conversations
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/conversations/?delete_ids=154,153,2"

# no result data - expected response status
HTTP/1.1 204 No Content

bash
# search all contacts for the term "userlike"
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/?search_query=userlike"

# results 1-10, ordered by search ranking, with pagination applied
{
    "count": 14,
    "next": "https://api.userlike.com/api/um/v3/contact_identities/?limit=10&offset=10&search_query=userlike",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# search all contacts that match the term "userlike" or "gregor"
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/?search_query=userlike+gregor"

# results 1-10, ordered by search ranking, with pagination applied
{
    "count": 14,
    "next": "https://api.userlike.com/api/um/v3/contact_identities/?limit=10&offset=10&search_query=userlike+gregor",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# GET list endpoint
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/"


# JSON data with results array and pagination info
{
    "count": 53,
    "next": "https://api.userlike.com/api/um/v3/conversations/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "accepts_messages": false,
            "addon_urls": {},
            "contact": {
                "city": null,
                "company": null,
                "contact_by_email": true,
                "contact_by_phone": false,
                "contact_by_userlike_channels": true,
                "contact_by_userlike_messenger": true,
                "country": null,
                "created_at": "2020-07-09T12:17:56.725918Z",
                "email": null,
                "email_verified": false,
                "external_customer_id": null,
                "first_message_sent_at": "2020-07-09T12:18:05.220985Z",
                "gender": null,
                "id": 5882,
                "is_blocked": false,
                "is_mobile_number_verified": false,
                "last_message_sent_at": "2020-07-09T12:18:39.825908Z",
                "loc_lat": 51.6017,
                "loc_lon": 7.2183,
                "locale": "en_US",
                "mobile_number": null,
                "name": null,
                "needs_register": true,
                "phone_number": null,
                "position": null,
                "read_permission": true,
                "salutation": null,
                "street": null,
                "url_facebook": null,
                "url_linkedin": null,
                "url_profile_picture": null,
                "url_twitter": null,
                "verified": false,
                "write_permission": true
            },
            "contact_channel": {
                "state": "valid", "type": "web"
            },
            "contact_first_message_sent_at": "2020-07-09T12:18:05.220985Z",
            "contact_last_message_sent_at": "2020-07-09T12:18:39.825908Z",
            "contact_last_update_at": "2020-07-09T12:19:15.212681Z",
            "conversation_contact_uuid": "099bc06d-a5ff-4830-b404-d91095352f77",
            "created_at": "2020-07-09T12:17:57.490194Z",
            "custom": {
                "basket": {
                    "item01": {
                        "desc": "33X Optical Zoom Camcorder Mini DV",
                        "id": "2acefe58-91e5-11e1-beba-000c2979313a",
                        "price": 139.99,
                        "url": "http://www.shop.com/en/electronics/34-camcorder.html"
                    },
                    "item02": {
                        "desc": "Home Theater System",
                        "id": "31aca2f2-91e5-11e1-beba-000c2979313a",
                        "long": "Lorem ipsum dolor sit amet",
                        "price": 499.99,
                        "url": "https://www.shop.com/en/electronics/39-home-theater.html"
                    }
                },
                "id": "428614f0-91e5-11e1-beba-000c2979313a",
                "ref": "3efd5462e"
            },
            "customer_id": 5,
            "data_privacy": false,
            "expiry_state": 0,
            "feedback_message": "I'm loving Userlike! Really awesome product seriously.",
            "id": 8982,
            "language_name": "English (US)",
            "last_message": {
                "body": "Great, thanks!",
                "conversation": {
                    "id": 8982
                },
                "conversation_id": 8982,
                "display_name": "Contact",
                "event": null,
                "id": "8982.12509.48084",
                "marked_read_contact": true,
                "marked_read_operator": true,
                "msgid": "8982.12509.48084",
                "name": "Contact",
                "operator_display_name": "",
                "operator_id": null,
                "operator_name": "",
                "part_id": 12509,
                "reference": null,
                "sender": {"id": 5882, "type": "contact"},
                "sent_at": "2020-07-09T12:18:39.825908Z",
                "sent_at_time": "12:18:39.825908",
                "state": {"error_code": null, "message": "Read by user", "type": 4},
                "type": "message",
                "url": null
            },
            "last_message_sent_at": "2020-07-09T12:19:18.669619Z",
            "locale": "en_US",
            "marked_read_contact": true,
            "marked_read_operator": true,
            "operator_assigned_to": 63,
            "organization_id": 8,
            "page_impressions": 1.0,
            "post_survey_option": null,
            "pre_survey_option": null,
            "rate": 5,
            "read_permission": true,
            "slot_reserved": false,
            "status": "ended",
            "status_description": "Ended",
            "subject": null,
            "topics": [{"id": 24,
            "organization_id": 8,
            "read_permission": true,
            "text": "Support",
            "write_permission": true}],
            "um_widget": {"id": 35,
            "language_name": "English (US)",
            "name": "Test"},
            "um_widget_goals": [],
            "unread_messages_operator": [],
            "updated_at": "2020-07-09T12:19:28.538574Z",
            "visits": null,
            "write_permission": true
        },
        {9 more conversation objects}
    ]
}

bash
# GET list all endpoint
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/all/?cursor=123&limit=100&ordering=id"


# JSON data with results array and pagination info
{
    "count": 53,
    "next": "https://api.userlike.com/api/um/v3/conversations/?cursor=223&limit=100&ordering=id",
    "previous": "https://api.userlike.com/api/um/v3/conversations/?cursor=-124&limit=100&ordering=id",
    "results": [
        {conversation object},
        ...
    ]
}

bash
# bulk delete 10 (by default) conversations
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/conversations/"

# no result data - expected response status
HTTP/1.1 204 No Content

bash
# filter all conversations for a certain operator
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?operator_id=154"

# filtered results 1-10 that match operator, pagination links have filters set
{
    "count": 22,
    "next": "https://api.userlike.com/api/um/v3/conversations/?operator_id=154&limit=10&offset=10",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

# filter all conversations since a certain date with a specific status
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?status=new&updated_at_from_date=2022-01-01T00:00:00"

# filtered results 1-10 that match date and status, pagination links have filters set
{
    "count": 23,
    "next": "https://api.userlike.com/api/um/v3/conversations/?contact_first_message_from_date=2022-01-01T00:00:00&limit=10&offset=10&status=new",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# delete all conversations of a certain operator
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/conversations/?operator_id=154"

# no result data - expected response status
HTTP/1.1 204 No Content

bash
# search all conversations for the term "userlike"
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?search_query=userlike"

# results 1-10, ordered by search ranking, with pagination applied
{
    "count": 14,
    "next": "https://api.userlike.com/api/um/v3/conversations/?limit=10&offset=10&search_query=userlike",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

javascript
# search and delete all conversations matching the term "userlike"
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/conversations/?search_query=userlike"

 # no result data - expected response status
 HTTP/1.1 204 No Content

bash
# GET single conversation with ID 199
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/199/"


# resulting JSON data with full conversation part set

{
    "accepts_messages": false,
    "addon_urls": {
        "github": "https://github.com/optixx/UserlikeTest/issues/36956",
        "jira": "https://userlike-dev.atlassian.net/browse/TEST-22874",
    },
    "contact": {
        "city": null,
        "company": null,
        "contact_by_email": true,
        "contact_by_phone": false,
        "contact_by_userlike_channels": true,
        "contact_by_userlike_messenger": true,
        "country": null,
        "created_at": "2020-07-09T12:17:56.725918Z",
        "email": null,
        "email_verified": false,
        "external_customer_id": null,
        "first_message_sent_at": "2020-07-09T12:18:05.220985Z",
        "gender": null,
        "id": 5882,
        "is_blocked": false,
        "is_mobile_number_verified": false,
        "last_message_sent_at": "2020-07-09T12:18:39.825908Z",
        "loc_lat": 51.6017,
        "loc_lon": 7.2183,
        "locale": "en_US",
        "mobile_number": null,
        "name": null,
        "needs_register": true,
        "phone_number": null,
        "position": null,
        "read_permission": true,
        "salutation": null,
        "street": null,
        "url_facebook": null,
        "url_linkedin": null,
        "url_profile_picture": null,
        "url_twitter": null,
        "verified": false,
        "write_permission": true
    },
    "contact_channel": {
        "state": "valid",
        "type": "web"
    },
    "contact_first_message_sent_at": "2020-07-09T12:18:05.220985Z",
    "contact_last_message_sent_at": "2020-07-09T12:18:39.825908Z"
    "contact_last_update_at": "2020-07-09T12:19:15.212681Z",
    "conversation_contact_uuid": "099bc06d-a5ff-4830-b404-d91095352f77",
    "conversation_part_set": [
        {
            "browser": {
                "name": "Chrome",
                "os": "Mac OS X",
                "version": "83"
            },
            "created_at": "2020-07-09T12:17:57.849820Z",
            "duration": "00:00:42",
            "ended_at": "2020-07-09T12:18:39.825000Z",
            "id": 12509,
            "location": {
                "city": "Recklinghausen",
                "country": "Germany",
                "lat": 51.6017,
                "lon": 7.2183
            },
            "name_friendly": "Conversation Part",
            "part_type": "ChatMeta",
            "read_permission": true,
            "referrer": null,
            "write_permission": true
        }
    ],
    "created_at": "2020-07-09T12:17:57.490194Z",
    "custom": {
        "basket": {
            "item01": {
                "desc": "33X Optical Zoom Camcorder Mini DV",
                "id": "2acefe58-91e5-11e1-beba-000c2979313a",
                "price": 139.99,
                "url": "http://www.shop.com/en/electronics/34-camcorder.html"
            },
            "item02": {
                "desc": "Home Theater System",
                "id": "31aca2f2-91e5-11e1-beba-000c2979313a",
                "long": "Lorem ipsum dolor sit amet",
                "price": 499.99,
                "url": "https://www.shop.com/en/electronics/39-home-theater.html"
            }
        },
        "id": "428614f0-91e5-11e1-beba-000c2979313a",
        "ref": "3efd5462e"
    },
    "customer_id": 5,
    "data_privacy": false,
    "expiry_state": 0,
    "feedback_message": "I'm loving Userlike! Really awesome product seriously.",
    "id": 199,
    "language_name": "English (US)",
    "last_message": {
        "body": "Great, thanks!",
        "conversation": {
            "id": 199
        },
        "conversation_id": 199,
        "display_name": "Contact",
        "event": null,
        "id": "199.12509.48084",
        "marked_read_contact": true,
        "marked_read_operator": true,
        "msgid": "199.12509.48084",
        "name": "Contact",
        "operator_display_name": "",
        "operator_id": null,
        "operator_name": "",
        "part_id": 12509,
        "reference": null,
        "sender": {
            "id": 5882,
            "type": "contact"
        },
        "sent_at": "2020-07-09T12:18:39.825908Z",
        "sent_at_time": "12:18:39.825908",
        "state": {
            "error_code": null,
            "message": "Read by user",
            "type": 4
        },
        "type": "message",
        "url": null
    },
    "last_message_sent_at": "2020-07-09T12:19:18.669619Z",
    "locale": "en_US",
    "marked_read_contact": true,
    "marked_read_operator": true,
    "operator_assigned_to": 63,
    "organization_id": 8,
    "page_impressions": 1.0,
    "post_survey_option": null,
    "pre_survey_option": null,
    "rate": 5,
    "read_permission": true,
    "slot_reserved": false,
    "status": "ended",
    "status_description": "Ended",
    "subject": null,
    "topics": [
        {
            "id": 24,
            "organization_id": 8,
            "read_permission": true,
            "text": "Support",
            "write_permission": true
        }
    ],
    "um_widget": {
        "id": 35,
        "language_name": "English (US)",
        "name": "Test"
    },
    "um_widget_goals": [],
    "unread_messages_operator": [],
    "updated_at": "2020-07-09T12:22:43.199704Z",
    "visits": null,
    "write_permission": true
}

bash
# delete conversation 199
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/conversations/199/"

# no result data - expected response status
HTTP/1.1 204 No Content

bash
# GET messages of conversation with ID 2017
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/2017/messages/?limit=3"

{
    "next": "https://api.userlike.com/api/um/v3/conversations/2017/messages/?cursor=2017.2522.14137&limit=3",
    "previous": null,
    "results": [
        {
            "id": "2017.2522.14139",
            "conversation_id": 2017,
            "part_id": 2522,
            "sent_at": "2021-07-29T08:49:16.891668Z",
            "operator_id": 2674,
            "reference": null,
            "type": "message",
            "event": null,
            "body": "Hi there! How do I install this?",
            "state": {
                "type": 1,
                "error_code": null,
                "message": "Submitted"
            },
            "url": null,
            "sent_at_time": "08:49:16.891668",
            "operator_display_name": "David Voswinkel",
            "operator_name": "David Voswinkel",
            "operator_is_bot": false,
            "marked_read_operator": false,
            "marked_read_contact": false,
            "msgid": "2017.2522.14139",
            "name": "David Voswinkel",
            "display_name": "David Voswinkel",
            "sender": {
                "type": "operator",
                "id": 2674
            },
            "conversation": {
                "id": 2017
            }
        },
        {
            "id": "2017.2522.14138",
            "conversation_id": 2017,
            "part_id": 2522,
            "sent_at": "2021-07-29T08:49:16.852722Z",
            "operator_id": null,
            "reference": null,
            "type": "message",
            "event": null,
            "body": "Hello, you're talking to David Voswinkel. How can I help?",
            "state": {
                "type": 3,
                "error_code": null,
                "message": "Delivered to contact"
            },
            "url": null,
            "sent_at_time": "08:49:16.852722",
            "operator_display_name": "",
            "operator_name": "",
            "operator_is_bot": false,
            "marked_read_operator": false,
            "marked_read_contact": false,
            "msgid": "2017.2522.14138",
            "name": "Jane Dough",
            "display_name": "Jane Dough",
            "sender": {
                "type": "contact",
                "id": 1833
            },
            "conversation": {
                "id": 2017
            }
        },
        {
            "id": "2017.2522.14137",
            "conversation_id": 2017,
            "part_id": 2522,
            "sent_at": "2021-07-29T08:49:16.822231Z",
            "operator_id": 2674,
            "reference": null,
            "type": "message",
            "event": null,
            "body": "Very easy, just follow this tutorial: https://www.userlike.com/tutorial/intro",
            "state": {
                "type": 1,
                "error_code": null,
                "message": "Submitted"
            },
            "url": null,
            "sent_at_time": "08:49:16.822231",
            "operator_display_name": "David Voswinkel",
            "operator_name": "David Voswinkel",
            "operator_is_bot": false,
            "marked_read_operator": false,
            "marked_read_contact": false,
            "msgid": "2017.2522.14137",
            "name": "David Voswinkel",
            "display_name": "David Voswinkel",
            "sender": {
                "type": "operator",
                "id": 2674
            },
            "conversation": {
                "id": 2017
            }
        }
    ]
}

bash
# GET list endpoint
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/"


# JSON data with results array and pagination info
{
    "count": 53,
    "next": "https://api.userlike.com/api/um/v3/contact_identities/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "city": "Cologne",
            "company": null,
            "contact_by_email": true,
            "contact_by_phone": false,
            "contact_by_userlike_channels": true,
            "contact_by_userlike_messenger": true,
            "contact_uuids": [
                "099bc06d-a5ff-4830-b404-d91095352f77"
            ],
            "conversation_count": 1,
            "country": "DE",
            "created_at": "2020-07-09T12:17:56.725918Z",
            "email": "test@userlike.com",
            "email_verified": false,
            "external_customer_id": null,
            "first_message_sent_at": "2020-07-09T12:18:05.220985Z",
            "gender": "f",
            "id": 53,
            "is_blocked": false,
            "is_mobile_number_verified": false,
            "last_message_sent_at": "2020-07-09T12:18:39.825908Z",
            "loc_lat": 51.6017,
            "loc_lon": 7.2183,
            "locale": "en_US",
            "mobile_number": null,
            "name": "Jane Doe",
            "needs_register": false,
            "phone_number": null,
            "position": null,
            "read_permission": true,
            "salutation": "ms",
            "street": null,
            "url_facebook": null,
            "url_linkedin": null,
            "url_profile_picture": null,
            "url_twitter": null,
            "verified": false,
            "write_permission": true
        },
        {9 more contact objects}
    ]
}

bash
# GET list all endpoint
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/all/?cursor=123&limit=100&ordering=id"


# JSON data with results array and pagination info
{
    "count": 53,
    "next": "https://api.userlike.com/api/um/v3/contact_identities/?cursor=223&limit=100&ordering=id",
    "previous": "https://api.userlike.com/api/um/v3/contact_identities/?cursor=-124&limit=100&ordering=id",
    "results": [
        {contact object},
        ...
    ]
}

bash
# bulk delete 10 (by default) contacts
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/contact_identities/"

# no result data - expected response status
HTTP/1.1 204 No Content

bash
# filter all contacts for a certain email
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/?email=test@userlike.com"

# filtered results that match a contact with given email
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {conversation object},
    ]
}

bash
# delete all contacts with a certain name
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/contact_identities/?name=Userlike%20Support"

# no result data - expected response status
HTTP/1.1 204 No Content

bash
# search all contacts for the term "userlike"
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/?search_query=userlike"

# results 1-10, ordered by search ranking, with pagination applied
{
    "count": 14,
    "next": "https://api.userlike.com/api/um/v3/contact_identities/?limit=10&offset=10&search_query=userlike",
    "previous": null,
    "results": [
        {conversation object},
        ...
    ]
}

bash
# search and delete all contacts matching the term "userlike"
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/contact_identities/?search_query=userlike"

 # no result data - expected response status
 HTTP/1.1 204 No Content

bash
# GET single contact with ID 42
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/contact_identities/42/"


# resulting JSON data with additional data
{
    "city": "Cologne",
    "company": null,
    "contact_by_email": true,
    "contact_by_phone": false,
    "contact_by_userlike_channels": true,
    "contact_by_userlike_messenger": true,
    "contact_uuids": [
        "099bc06d-a5ff-4830-b404-d91095352f77"
    ],
    "conversation_count": 1,
    "country": "DE",
    "created_at": "2020-07-09T12:17:56.725918Z",
    "email": "test@userlike.com",
    "email_verified": false,
    "external_customer_id": null,
    "first_message_sent_at": "2020-07-09T12:18:05.220985Z",
    "gender": "f",
    "id": 42,
    "is_blocked": false,
    "is_mobile_number_verified": false,
    "last_message_sent_at": "2020-07-09T12:18:39.825908Z",
    "loc_lat": 51.6017,
    "loc_lon": 7.2183,
    "locale": "en_US",
    "mobile_number": null,
    "name": "Jane Doe",
    "needs_register": false,
    "phone_number": null,
    "position": null,
    "read_permission": true,
    "salutation": "ms",
    "street": null,
    "url_facebook": null,
    "url_linkedin": null,
    "url_profile_picture": null,
    "url_twitter": null,
    "verified": false,
    "write_permission": true
}

bash
# update how a contact wants to be saluted
curl --request PATCH \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/contact_identities/3126/" \
     --data '{"salutation":"prof"}'

 # result is the updated resource item
 {patched resource item}

# update status, operator and subject of a certain conversation at once
curl --request PATCH \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/contact_identities/3126/" \
     --data '{"gender": "m", "contact_by_email": true, "city": "Cologne", "country": "DE"}'

 # result is the updated resource item
 {patched resource item}

bash
# delete contact 42
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/contact_identities/42/"

# no result data - expected response status
HTTP/1.1 204 No Content

bash
# GET list endpoint
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/operators/"


# JSON data with results array and pagination info
{
    "count": 20,
    "next": "https://api.userlike.com/api/um/v3/operators/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "about_me": "",
            "account_type": "normal",
            "created_at": "2020-07-03T09:48:27.292124Z",
            "created_at_timezone": "Atlantic/Reykjavik",
            "created_at_utc": "2020-07-03 09:48:27",
            "display_name": "David Voswinkel",
            "email": "test@userlike.com",
            "enabled": true,
            "first_name": "David",
            "id": 21,
            "inactivity_repeat_timeout": 0,
            "inactivity_sound": false,
            "inactivity_sound_file": "inactivity",
            "inactivity_sound_volume": 1.0,
            "inactivity_timeout": 30000,
            "is_active": true,
            "is_locked": false,
            "is_locked_or_is_disabled": false,
            "is_role_admin": false,
            "is_role_agent": false,
            "is_role_staff": false,
            "job_title": "",
            "lang": "en",
            "last_login_at": null,
            "last_login_at_timezone": null,
            "last_login_at_utc": null,
            "last_name": "Voswinkel",
            "locale": "en_US",
            "name": "David Voswinkel",
            "notification_mute": false,
            "operator_group": {
                "id": 25,
                "name": "Testing David Voswinkel",
                "read_permission": true,
                "write_permission": true
            },
            "organization": {
                "id": 8,
                "name": "Testing"
            },
            "out_of_office": false,
            "read_permission": true,
            "role": "m",
            "role_name": "Manager",
            "skills": [],
            "sound_connect": true,
            "sound_disconnect": true,
            "sound_message_new": true,
            "sound_operator_off": false,
            "sound_operator_on": false,
            "timezone": "Atlantic/Reykjavik",
            "timezone_offset": 0,
            "um_away": false,
            "um_email_profile": "unread",
            "um_notification_addon_created": true,
            "um_notification_addon_updated": true,
            "um_notification_chat_session_forward": true,
            "um_notification_chat_session_forward_new": true,
            "um_notification_chat_session_start_other": true,
            "um_notification_chat_session_start_own": true,
            "um_notification_conversation_end": true,
            "um_notification_conversation_feedback": true,
            "um_notification_conversation_goal": true,
            "um_notification_conversation_post_survey": true,
            "um_notification_conversation_rating": true,
            "um_notification_message_receive": false,
            "um_notification_message_sent": false,
            "um_notification_widget_config": false,
            "um_notification_conversation_new_offline": true,
            "um_notification_conversation_not_live": true,
            "um_notification_conversation_end_own": true,
            "um_notification_conversation_feedback_own": true,
            "um_notification_conversation_goal_own": true,
            "um_notification_conversation_new_unassigned": true,
            "um_notification_conversation_new_relevant": true,
            "um_notification_conversation_post_survey_own": true,
            "um_notification_conversation_rating_own": true,
            "um_notification_operator_availability": true,
            "um_slots": {
                "availability": "offline",
                "available": false,
                "connected": false,
                "free": 0,
                "total": 5,
                "used": 0
            },
            "umc_settings": {},
            "url_image": "https://www.userlike.com/profile.jpg",
            "username": "testingdavidvoswinkel",
            "write_permission": true
        },
        {9 more operator objects}
    ]
}

bash
# filter all operator for a certain operator group
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/operators/?operator_group_id=132"

# filtered results of operators belongig to the given operator group
{
    "count": 15,
    "next": "https://api.userlike.com/api/um/v3/operators/?limit=10&offset=10&operator_group_id=132",
    "previous": null,
    "results": [
        {operator objects},
    ]
}

bash
# GET single operator with ID 144
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/operators/144/"


# resulting JSON data with additional data
{
    "about_me": "",
    "account_type": "normal",
    "created_at": "2020-07-03T09:48:27.292124Z",
    "created_at_timezone": "Atlantic/Reykjavik",
    "created_at_utc": "2020-07-03 09:48:27",
    "display_name": "David Voswinkel",
    "email": "test@userlike.com",
    "enabled": true,
    "first_name": "David",
    "id": 144,
    "inactivity_repeat_timeout": 0,
    "inactivity_sound": false,
    "inactivity_sound_file": "inactivity",
    "inactivity_sound_volume": 1.0,
    "inactivity_timeout": 30000,
    "is_active": true,
    "is_locked": false,
    "is_locked_or_is_disabled": false,
    "is_role_admin": false,
    "is_role_agent": false,
    "is_role_staff": false,
    "job_title": "",
    "lang": "en",
    "last_login_at": null,
    "last_login_at_timezone": null,
    "last_login_at_utc": null,
    "last_name": "Voswinkel",
    "locale": "en_US",
    "name": "David Voswinkel",
    "notification_mute": false,
    "operator_group": {
        "id": 25,
        "name": "Testing David Voswinkel",
        "read_permission": true,
        "write_permission": true
    },
    "organization": {
        "id": 8,
        "name": "Testing"
    },
    "out_of_office": false,
    "read_permission": true,
    "role": "m",
    "role_name": "Manager",
    "skills": [],
    "sound_connect": true,
    "sound_disconnect": true,
    "sound_message_new": true,
    "sound_operator_off": false,
    "sound_operator_on": false,
    "timezone": "Atlantic/Reykjavik",
    "timezone_offset": 0,
    "um_away": false,
    "um_email_profile": "unread",
    "um_notification_addon_created": true,
    "um_notification_addon_updated": true,
    "um_notification_chat_session_forward": true,
    "um_notification_chat_session_forward_new": true,
    "um_notification_chat_session_no_operator": true,
    "um_notification_chat_session_start_other": true,
    "um_notification_chat_session_start_own": true,
    "um_notification_conversation_end": true,
    "um_notification_conversation_feedback": true,
    "um_notification_conversation_goal": true,
    "um_notification_conversation_post_survey": true,
    "um_notification_conversation_rating": true,
    "um_notification_message_receive": false,
    "um_notification_message_sent": false,
    "um_notification_widget_config": false,
    "um_notification_conversation_new_offline": true,
    "um_notification_conversation_not_live": true,
    "um_notification_conversation_end_own": true,
    "um_notification_conversation_feedback_own": true,
    "um_notification_conversation_goal_own": true,
    "um_notification_conversation_new_unassigned": true,
    "um_notification_conversation_new_relevant": true,
    "um_notification_conversation_post_survey_own": true,
    "um_notification_conversation_rating_own": true,
    "um_notification_operator_availability": true,
    "um_slots": {
        "availability": "offline",
        "available": false,
        "connected": false,
        "free": 0,
        "total": 5,
        "used": 0
    },
    "umc_settings": {},
    "url_image": "https://www.userlike.com/profile.jpg",
    "username": "testingdavidvoswinkel",
    "write_permission": true
}

bash
# update out_of_office of a certain operator
curl --request PATCH \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/operators/{id}/" \
     --data '{"out_of_office": true}'

 # result is the updated resource item
 {patched resource item}

# update out_of_office, notification_mute and sound_operator_on of a certain operator at once
curl --request PATCH \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/operators/{id}/" \
     --data '{"out_of_office": true, "notification_mute": false, "sound_operator_on": true}'

 # result is the updated resource item
 {patched resource item}

bash
# set a certain operator to away
curl --location --request PATCH 'https://api.userlike.com/api/um/v3/operators/{id}/away/' \
     --header 'Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf' \
     --header 'Content-Type: application/json' \
     --data '{"away": true}'

# resulting JSON response, containing only the Operator's id and slot data
{
    "id": 5,
    "um_slots": {
        "available": false,
        "availability": "unavailable",
        "free": 0,
        "used": 0,
        "total": 5,
        "connected": true
    }
}

bash
# delete operator 144
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/operators/144/"

# no result data - expected response status
HTTP/1.1 204 No Content

• Delete the Owner of your Userlike account

• Delete the operator making the request (which in most cases is the Owner)

• Delete the last operator of an organization

bash
# try deleting the owner
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/operators/140/"

# result explaining the 403 Forbidden
{
    "detail":"Cannot delete owner"
}

# try deleting the operator making the call
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "USERLIKE-OPERATOR-ID: 155" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/operators/155/"

# result explaining the 403 Forbidden status
{
    "detail":"Cannot delete operator making the request"
}

bash
# GET chat slot utilization for operator 144
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/operators/5/slots/"


# resulting JSON, containing only the Operator's id and slot data
{
    "id": 5,
    "um_slots": {
        "availability": "unavailable",
        "available": false,
        "connected": true,
        "free": 0,
        "total": 5,
        "used": 0
    }
}

• text: A string within the configured minimum and maximum length.

• number: A string containing only numbers. If decimals are allowed, they should be separated with a period (.).

• select: A string that corresponds to the Option ID.

• multi-select: A list of strings, each referring to an individual Option ID.

bash
# get conversations updated on the 1st January, 2022
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversations/?updated_at_from_date=2022-01-01T00:00:00&updated_at_to_date=2022-01-02T00:00:00"

python
import requests
import os
import json

API_TOKEN = os.environ.get("API_TOKEN") or "ee6bd15d-c8f7-3c55-b7dd-82e5970418cf"
API_HOST = os.environ.get("API_HOST") or "https://api.userlike.com"
headers = {"Authorization": API_TOKEN}

# make request, using the authorization header we just defined
resp = requests.get(
    "{}/api/um/v3/conversations/".format(API_HOST), headers=headers, verify=False
)

if resp.status_code == 200:
    print(json.dumps(resp.json(), indent=4, sort_keys=True))
else:
    print("Error status=%s" % resp.status_code)

python
import requests
import os

API_TOKEN = os.environ.get("API_TOKEN") or "ee6bd15d-c8f7-3c55-b7dd-82e5970418cf"
API_HOST = os.environ.get("API_HOST") or "https://api.userlike.com"
headers = {"Authorization": API_TOKEN}

# Data from your CRM
CUSTOMER_DATA = [
    {"email": "john.doe@example.com", "mobile_number": "+4917123456789"},
    # ...
]

for customer in CUSTOMER_DATA:
    # 1. Get contact data
    filter_params = {"email": customer["email"]}
    resp = requests.get(
        "{}/api/um/v3/contact_identities/".format(API_HOST),
        headers=headers,
        params=filter_params,
        verify=False,
    )

    assert resp.json()["count"] == 1
    contact = resp.json()["results"][0]

    # 2. Update mobile number in contact
    # Using the json parameter in requests automatically sets the 'Content-Type'
    # in the header to 'application/json'. With other libraries, you might have
    # to the the 'Content-Type' header manually for PATCH requests.
    resp = requests.patch(
        "{}/api/um/v3/contact_identities/{}/".format(API_HOST, contact["id"]),
        headers=headers,
        json={"mobile_number": customer["mobile_number"]},
        verify=False,
    )
    assert resp.status_code == 200
    print(f"Updated {customer['email']}")

javascript
# get next 100 navigations after navigation with id 1000 for conversation 123
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/navigation/?conversation_id=123&id__gt=1000&page_size=100"

# get previous 100 navigations before navigation with id 1000 for conversation 123
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/navigation/?conversation_id=123&id__lt=1000&page_size=100"

# the response could look like this
# count_earlier and count_later tells you whether you have all events, or if
# there are still some left to be fetched. In this case there are 100 navigation
# events left to fetch that come after the last result:
{
    "count_earlier": 0,
    "count_later": 100,
    "results": [...],
}

javascript
# GET navigations that happened during conversation with ID 2013
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/navigation/?conversation_id=2013"

# GET navigations of contact with ID 1345
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/navigation/?contact_identity_id=1831"


# This is what the result could look like:
{
    "count_earlier": 0,
    "count_later": 0,
    "results": [
        {
            "contact_identity_id": 1831,
            "read_permission": true,
            "title": "Userlike Test Page",
            "url": "https://userlike.com/",
            "created_at": "2021-07-28T15:13:27.813938Z",
            "write_permission": true,
            "organization_id": 3,
            "conversation_id": 2013,
            "customer_id": 2,
            "id": 67
        },
        {
            "contact_identity_id": 1831,
            "read_permission": true,
            "title": "Userlike Test Page",
            "url": "https://userlike.com/product",
            "created_at": "2021-07-28T15:13:21.837302Z",
            "write_permission": true,
            "organization_id": 3,
            "conversation_id": 2013,
            "customer_id": 2,
            "id": 66
        },
        {
            "contact_identity_id": 1831,
            "read_permission": true,
            "title": "Userlike Test Page",
            "url": "https://userlike.com/register",
            "created_at": "2021-07-28T15:13:15.770674Z",
            "write_permission": true,
            "organization_id": 3,
            "conversation_id": 2013,
            "customer_id": 2,
            "id": 65
        },
    ]
}

bash
# delete note 2344
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --request DELETE \
     "https://api.userlike.com/api/um/v3/notes/2344/"

# no result data - expected response status
HTTP/1.1 204 No Content

bash
# GET single note with ID 2344
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/notes/2344/"


# resulting JSON data

{
    "id": 2344,
    "conversation_id": 5882,
    "contact_identity_id": null,
    "message_id": 1542,
    "operator_id": 64,
    "body": "This issue has been reported before.",
    "msgid": "218.274.1542",
    "created_at": "2021-08-09T15:10:22.687027Z"
}

bash
# Create a single note in a conversation
curl --request POST \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/notes/" \
     --data '{"conversation_id": 5882, "body": "This **issue** has been reported before", "text_format": "markdown_v1", "msgid": "5882.8944.143346"}'


# resulting JSON data

{
    "id": 2344,
    "conversation_id": 5882,
    "contact_identity_id": null,
    "message_id": 1542,
    "operator_id": 64,
    "body": "This **issue** has been reported before.",
    "msgid": "5882.8944.143346",
    "created_at": "2021-08-09T15:10:22.687027Z",
    "text_format": "markdown_v1"
}

# Create a single note for a contact
curl --request POST \
     --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     --header "Content-Type: application/json" \
     "https://api.userlike.com/api/um/v3/notes/" \
     --data '{"contact_identity_id": 50670, "body": "Is highly interested in our new product."}'


# resulting JSON data

{
    "id": 2345,
    "conversation_id": null,
    "contact_identity_id": 50670,
    "message_id": null,
    "operator_id": 64,
    "body": "Is highly interested in our new product.",
    "msgid": null,
    "created_at": "2021-08-09T15:10:22.687027Z"
}

javascript
// GET list endpoint
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/notes/"


// JSON data with results array and pagination info
{
    "count": 12,
    "next": https://api.userlike.com/api/um/v3/notes/?limit=10&offset=10,
    "previous": null,
    "results": [
        {
            "id": 2344,
            "conversation_id": 5882,
            "contact_identity_id": null,
            "message_id": 1542,
            "operator_id": 65,
            "body": "This issue has been reported before.",
            "msgid": "218.274.1542",
            "created_at": "2021-08-09T15:10:22.687027Z",
            "text_format": "markdown_v1"
        },
        {
            "id": 2343,
            "conversation_id": 8982,
            "contact_identity_id": null,
            "message_id": 1575,
            "operator_id": 64,
            "body": "Already fixed in ticket #4711",
            "msgid": "218.274.1542",
            "created_at": "2021-08-09T11:33:12.046284Z"
            "text_format": "plain_text"
        },
        {8 more note objects}
    ]
}

bash
# filter all notes for a certain conversation
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/notes/?conversation_id=5882"

# filtered results 1-10 that match conversation_id, pagination links have filter set
{
    "count": 12,
    "next": "https://api.userlike.com/api/um/v3/notes/?conversation_id=58828&limit=10&offset=10",
    "previous": null,
    "results": [
        {note object},
        ...
    ]
}

# filter all notes for a certain contact
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/notes/?contact_identity_id=23"

# filtered results 1-10 that match contact_identity_id, pagination links have filter set
{
    "count": 23,
    "next": "https://api.userlike.com/api/um/v3/notes/?contact_identity_id=23&limit=10&offset=10",
    "previous": null,
    "results": [
        {note object},
        ...
    ]
}

bash
# GET list endpoint
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/notes/"


# JSON data with results array and pagination info
{
    "count": 12,
    "next": https://api.userlike.com/api/um/v3/notes/?limit=10&offset=10,
    "previous": null,
    "results": [
        {
            "id": 2344,
            "conversation_id": 5882,
            "contact_identity_id": null,
            "message_id": 1542,
            "operator_id": 65,
            "body": "This issue has been reported before.",
            "msgid": "218.274.1542",
            "created_at": "2021-08-09T15:10:22.687027Z"
        },
        {
            "id": 2343,
            "conversation_id": 8982,
            "contact_identity_id": null,
            "message_id": 1575,
            "operator_id": 64,
            "body": "Already fixed in ticket #4711",
            "msgid": "218.274.1542",
            "created_at": "2021-08-09T11:33:12.046284Z"
        },
        {8 more note objects}
    ]
}

bash
# get messages after message with reference "2015.2508.14032"
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/v3/conversation/123/messages/?ordering=id&cursor=2015.2508.14032&limit=50"

# JSON data with results array and pagination info
# you will automatically get a link to access the 50 messages that come after the latest results in
# "next" and a link to access the 50 results that come before the first result in "previous"
{
    "next": "https://api.userlike.com/api/um/v3/conversation/123/messages/?cursor=2015.2508.14082&limit=50",
    "previous": "https://api.userlike.com/api/um/v3/conversation/123/messages/?cursor=-2015.2508.13900&limit=50",
    "results": [...]
}

bash
# GET medial details
curl --header "Authorization: ee6bd15d-c8f7-3c55-b7dd-82e5970418cf" \
     "https://api.userlike.com/api/um/media/download/3-0ee5f3d95a4d89e2a6e28fbb7c8f9d3a.png"

{
    "mime_type": "image/png",
    "title": "car_front_image.png",
    "url": "https://example-file-download.url"  # url for the binary data
}