Skip to main content
POST
/
v1
/
quickstarts
/
assignments
Create a new assignment
curl --request POST \
  --url https://api.avidoai.com/v1/quickstarts/assignments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "stage": "KB_REVIEW",
  "assignedTo": "user_789012",
  "topicId": "789e4567-e89b-12d3-a456-426614174000"
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "stage": "KB_REVIEW",
    "assignedTo": "user_789012",
    "topicId": "789e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "assignedUser": {
      "id": "user_789012",
      "name": "John Doe",
      "email": "john@example.com",
      "image": "https://example.com/avatar.jpg"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating a new assignment

​
stage
enum<string>
required

The review stage this assignment belongs to

Available options:
KB_REVIEW,
TASKS_TOPICS_REVIEW
Example:

"KB_REVIEW"

​
assignedTo
string
required

User ID to assign to

Required string length: 1 - 255
Example:

"user_789012"

​
topicId
string<uuid>
required

Topic ID to assign

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"789e4567-e89b-12d3-a456-426614174000"

Response

Successfully created assignment

Successful response containing the assignment data

​
data
AssignmentQuickstart · object
required

An assignment linking a user to a topic for a review stage