Transcripts

Transcripts are an essential part of Uplodr — they are the containers for the questions between you, your employees, and stores. On this page, we’ll dive into the different transcript endpoints you can use to manage transcripts programmatically. We'll look at how to query, create, update, and delete transcripts.

The transcript model

The transcript model contains all the information about the transcripts between you and your employees. In addition, transcripts can also be store-based with more than one employee, they can have a pinned question, and they can be muted.

Properties

Name
id
Type
string
Description
Unique identifier for the transcript.
Name
employee_id
Type
string
Description
Unique identifier for the other employee in the transcript.
Name
store_id
Type
string
Description
Unique identifier for the store that the transcript belongs to.
Name
pinned_question_id
Type
string
Description
Unique identifier for the pinned question.
Name
is_pinned
Type
boolean
Description
Whether or not the transcript has been pinned.
Name
is_muted
Type
boolean
Description
Whether or not the transcript has been muted.
Name
last_active_at
Type
timestamp
Description
Timestamp of when the transcript was last active.
Name
last_opened_at
Type
timestamp
Description
Timestamp of when the transcript was last opened by the authenticated user.
Name
created_at
Type
timestamp
Description
Timestamp of when the transcript was created.
Name
archived_at
Type
timestamp
Description
Timestamp of when the transcript was archived.

GET/v1/transcripts

List all transcripts

This endpoint allows you to retrieve a paginated list of all your transcripts. By default, a maximum of ten transcripts are shown per page.

Optional attributes

Name
limit
Type
integer
Description
Limit the number of transcripts returned.
Name
muted
Type
boolean
Description
Only show transcripts that are muted when set to true.
Name
archived
Type
boolean
Description
Only show transcripts that are archived when set to true.
Name
pinned
Type
boolean
Description
Only show transcripts that are pinned when set to true.
Name
store_id
Type
string
Description
Only show transcripts for the specified store.

Request

GET

/v1/transcripts

curl -G https://api.uplodr.chat/v1/transcripts \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "id": "xgQQXg3hrtjh7AvZ",
      "employee_id": "WAz8eIbvDR60rouK",
      "store_id": null,
      "pinned_question_id": null,
      "is_pinned": false,
      "is_muted": false,
      "last_active_at": 705103200,
      "last_opened_at": 705103200,
      "created_at": 692233200,
      "archived_at": null
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

POST/v1/transcripts

Create a transcript

This endpoint allows you to add a new transcript between you and a employee or store. A employee or store id is required to create a transcript.

Required attributes

Name
employee_id
Type
string
Description
Unique identifier for the other employee in the transcript.
Name
store_id
Type
string
Description
Unique identifier for the store that the transcript belongs to.

Request

POST

/v1/transcripts

curl https://api.uplodr.chat/v1/transcripts \
  -H "Authorization: Bearer {token}" \
  -d 'employee_id'="WAz8eIbvDR60rouK"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "employee_id": "WAz8eIbvDR60rouK",
  "store_id": null,
  "pinned_question_id": null,
  "is_pinned": false,
  "is_muted": false,
  "last_active_at": null,
  "last_opened_at": null,
  "created_at": 692233200,
  "archived_at": null
}

GET/v1/transcripts/:id

Retrieve a transcript

This endpoint allows you to retrieve a transcript by providing the transcript id. Refer to the list at the top of this page to see which properties are included with transcript objects.

Request

GET

/v1/transcripts/xgQQXg3hrtjh7AvZ

curl https://api.uplodr.chat/v1/transcripts/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "employee_id": "WAz8eIbvDR60rouK",
  "store_id": null,
  "pinned_question_id": null,
  "is_pinned": false,
  "is_muted": false,
  "last_active_at": 705103200,
  "last_opened_at": 705103200,
  "created_at": 692233200,
  "archived_at": null
}

PUT/v1/transcripts/:id

Update a transcript

This endpoint allows you to perform an update on a transcript. Examples of updates are pinning a question, muting or archiving the transcript, or pinning the transcript itself.

Optional attributes

Name
pinned_question_id
Type
string
Description
Unique identifier for the pinned question.
Name
is_pinned
Type
boolean
Description
Whether or not the transcript has been pinned.
Name
is_muted
Type
boolean
Description
Whether or not the transcript has been muted.
Name
archived_at
Type
timestamp
Description
Timestamp of when the transcript was archived.

Request

PUT

/v1/transcripts/xgQQXg3hrtjh7AvZ

curl -X PUT https://api.uplodr.chat/v1/transcripts/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}" \
  -d 'is_muted'=true

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "employee_id": "WAz8eIbvDR60rouK",
  "store_id": null,
  "pinned_question_id": null,
  "is_pinned": false,
  "is_muted": true,
  "last_active_at": 705103200,
  "last_opened_at": 705103200,
  "created_at": 692233200,
  "archived_at": null
}

DELETE/v1/transcripts/:id

Delete a transcript

This endpoint allows you to delete your transcripts in Uplodr. Note: This will permanently delete the transcript and all its questions — archive it instead if you want to be able to restore it later.

Request

DELETE

/v1/transcripts/xgQQXg3hrtjh7AvZ

curl -X DELETE https://api.uplodr.chat/v1/transcripts/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"