Open a review on a session

POST

https://studio.runautomat.com/api/v1/projects/:projectId/collaboration/reviews

POST

/api/v1/projects/:projectId/collaboration/reviews

curl -X POST https://studio.runautomat.com/api/v1/projects/projectId/collaboration/reviews \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "sessionId": "string",
  "body": "string",
  "visibility": "shared"
}'

201Created

{
  "thread": {
    "id": "string",
    "subject_type": "string",
    "subject_id": "string",
    "session_id": "string",
    "workflow_id": "string",
    "review_status": "none",
    "waiting_on": "customer",
    "waiting_on_user_id": "string",
    "source": "human",
    "opened_by_id": "string",
    "opened_at": "string",
    "resolved_by_id": "string",
    "resolved_at": "string",
    "created_at": "string",
    "commentCount": 1.1,
    "lastActivityAt": "string",
    "acknowledgements": [
      {
        "userId": "string",
        "userSide": "customer",
        "acknowledgedAt": "string"
      }
    ]
  },
  "threadId": "string",
  "commentId": "string"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequired

Request

This endpoint expects an object.

sessionIdstringRequiredformat: "uuid"

bodystringRequired1-10000 characters

visibilityenumRequired

Allowed values:

anchorobjectOptional

fileIdslist of stringsOptional

Response

Declared primary response

threadobject or null

threadIdstring

commentIdstring