Skip to main content
PATCH
/
{version}
/
assignment-records
/
{assignment_record}
Update assignment record
curl --request PATCH \
  --url https://api.perscom.io/{version}/assignment-records/{assignment_record} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": 123,
  "status_id": 123,
  "unit_id": 123,
  "position_id": 123,
  "specialty_id": 123,
  "document_id": 123,
  "author_id": 123,
  "type": "primary",
  "text": "<string>"
}'
{
  "data": {
    "id": 123,
    "user_id": 123,
    "status_id": 123,
    "unit_id": 123,
    "position_id": 123,
    "specialty_id": 123,
    "document_id": 123,
    "author_id": 123,
    "type": "primary",
    "text": "<string>",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
assignment_record
integer
required

Query Parameters

include
enum<string>
Available options:
attachments,
author,
author.*,
comments,
comments.*,
document,
position,
specialty,
status,
unit,
unit.*,
user,
user.*

Body

application/json
user_id
integer
required

The ID of the user this assignment record belongs to.

type
enum<string>
required

The type of assignment record.

Available options:
primary,
secondary
status_id
integer | null

The ID of the status assigned to the user.

unit_id
integer | null

The ID of the unit assigned to the user.

position_id
integer | null

The ID of the position assigned to the user.

specialty_id
integer | null

The ID of the specialty assigned to the user.

document_id
integer | null

The ID of the document associated with this assignment record.

author_id
integer

The ID of the user who created this assignment record.

text
string | null

Additional notes or information about this assignment record. Supports HTML.

Maximum length: 65535

Response

OK

data
object
I