/api/v1/object/data/{objectSlug}/{recordSlug}/positionMove a record between two others in manual board order.
Move a record between two others in manual board order.
Name the new neighbours: before_slug is the record just above, and
after_slug the record just below. Omit before_slug to move to the
top, or after_slug to move to the bottom; send at least one. Returns the
record's new position, a decimal number in a string; compare positions
as numbers. This only changes the order: to move a record to another
board column, update its column field first with
PUT /object/data/{objectSlug}/{recordSlug}.
Scope: update.<object slug>, for example update.contacts.
Errors:
400— neither neighbour is sent, a neighbour is the record itself, or no active object has that slug.403— the credential may not edit this record.404— the record or a neighbour does not exist.
Request:
{
"before_slug": "c83e1a5f2d97",
"after_slug": "7b0d3e9c4a18"
}
Response 200:
{
"status": 200,
"message": "Position updated",
"data": { "position": "1500" }
}
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredSlug of the card the moved one now sits below.
Slug of the card the moved one now sits above.
Responses
Successful response
{
"message": "string",
"data": "string"
}Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs