Add or remove Karats to/from a given person.
If successful, this endpoint will return a 200 OK status.
The following arguments are supported for this endpoint.
| Name | Type | Default Value |
|---|---|---|
|
person Required |
Person Lookup | None |
|
quantity Required |
Integer | None |
|
description Required |
String | None |
|
url |
String | None |
|
category |
String | other |
|
source |
String | None |
|
anti_replay_token |
String | None |
The following errors may occur during this request.
| Details | HTTP status |
|---|---|
|
No person was found matching any of the criteria provided in the arguments |
404 Not Found |
|
The anti-replay token has already been used for this person |
409 Conflict |
|
A validation error occurred with the object that was being created/updated/deleted |
422 Unprocessable Entity |
When the request is successful, you can expect an object matching the specification below to be returned.
{ karat: Karat { id: Integer quantity: Integer balance: Integer description: String created_at: Unix Timestamp type: String category: String? url: String? source: String? person: Person { id: Integer first_name: String last_name: String full_name: String job_title: String } } }