1. API reference
  3. Crm
  5. Update an object's name, description, icon, status or folder.
  • API reference
  • GETIdentify the calling credential.
  • GETList the webhook events you can subscribe to.
  • GETList the webhook subscriptions this credential owns.
  • POSTSubscribe an HTTPS endpoint to record events on one object.
  • GETGet one webhook subscription by slug.
  • DELETEDelete a webhook subscription.
  • GETList the field types you can create.
  • GETList the file formats a file field can accept.
  • GETList the active tag fields of all objects, one page at a time.
  • GETList every field in the workspace, one page at a time.
  • GETList the fields of an object, one page at a time.
  • POSTAdd a field to an object.
  • GETList all fields an object owns, active and inactive.
  • GETList the active fields of an object, relations included.
  • GETList the select, status and priority fields of an object.
  • GETList the fields that can make another field required.
  • GETGet one field by slug.
  • POSTCopy fields of an object into other objects.
  • POSTAdd one choice to a choice field.
  • PUTChange the order of an object's fields.
  • PUTUpdate a field's settings.
  • DELETEDelete a field and its values.
  • PUTTurn a field on or off on an object.
  • GETList the workspace tags.
  • POSTAdd a tag to the workspace list.
  • PUTReorder the workspace tags.
  • POSTAdd a tag from a record of one object.
  • GETGet one tag with its usage.
  • DELETEDelete a tag, or retire it when records still hold it.
  • PATCHRename or recolor a tag.
  • GETList which optional record features this deployment has turned on.
  • GETList objects, one page at a time.
  • POSTCreate an object.
  • GETList the active objects the credential can read.
  • GETCount records and saved views for each active object.
  • GETGet workspace totals for records, saved views and objects.
  • GETList the duplicate-detection rule of every object.
  • GETCheck whether an object name is free to use.
  • GETGet one object by slug.
  • PUTUpdate an object's name, description, icon, status or folder.
  • DELETEDelete an object and all of its records.
  • GETList the other active objects, for picking a relation target.
  • GETList the active fields of an object.
  • GETGet the duplicate-detection rule of an object.
  • PUTSet the duplicate-detection rule of an object.
  • PUTChange the display order of objects.
  • PUTTurn an object on or off.
  • PUTTurn an object's public form on or off.
  • GETList records as slug and name pairs, for pickers.
  • GETList an object's records, with filters and sorting.
  • POSTCreate a record.
  • POSTSearch an object's records by free text.
  • GETList the records you can link through every relation of an object.
  • GETList the records you can link through one relation field.
  • GETList the records that share a value in one field.
  • GETList the values of dependent filter fields.
  • GETList the records linked to one record through one relation.
  • POSTList the distinct values stored in one field, most common first.
  • POSTGet badge counts for a set of records.
  • GETList the options a select-type field allows.
  • GETGet one record by slug, with its columns and change history.
  • PUTUpdate a record.
  • DELETEDelete a record.
  • GETList every change to one record, newest first.
  • GETList one page of a record's change history, with filters.
  • POSTDuplicate a record.
  • POSTCreate a record from a quick-add row in a table or board.
  • POSTUpdate, assign or delete many records in one call.
  • POSTDuplicate many records in one call.
  • POSTCancel a queued or running bulk job.
  • GETGet the report of a bulk job.
  • POSTDelete up to 500 records by slug.
  • POSTSet the assignees of up to 500 records.
  • PATCHReplace the assignees of a record.
  • PATCHMove a record between two others in manual board order.
  • POSTApply the same change to up to 500 records.
  • DELETEDelete all records of an object.
  • GETGet a short-lived URL for one stored file.
  • GETDownload one stored file.
  • POSTGet short-lived URLs for up to 100 stored files in one call.
PUT/api/v1/object/{objectSlug}

Update an object's name, description, icon, status or folder.

Update an object's name, description, icon, status or folder.

Send only the fields you change. The slug never changes. A new name is trimmed and must not match another active object's name, ignoring letter case. is_public turns the object's public form on or off. folder_slug moves the object into a folder; send null to take it out.

Scope: object.update.

Errors:

  • 400 — no object has that slug, the object is inactive, the name is empty, or no folder has that folder_slug.
  • 409 — another active object already has this name.
  • 422 — the body is invalid, for example a slug property.

Request:

{
  "name": "Customers",
  "icon": "tabler-user-check"
}

Response 200:

{
  "status": 200,
  "message": "Object updated successfully",
  "data": {
    "id": 37,
    "name": "Customers",
    "slug": "contacts",
    "icon": "tabler-user-check",
    "description": "People we sell to",
    "permission_name": "contacts",
    "is_active": true,
    "sort_order": 2,
    "is_system": false,
    "is_public": false,
    "options": null,
    "created_at": "2026-07-20T09:12:44.000Z",
    "updated_at": "2026-09-14T10:00:00.000Z",
    "folder_slug": null,
    "default_view_slug": null,
    "default_view_type": null
  }
}

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL
Bearer tokenbearerAuthoptional
Stored only in this browser for the bearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

objectSlugpath · stringrequired

Request body

application/jsonrequired
nameobjectoptional
descriptionobjectoptional
iconobjectoptional
is_activeobjectoptional
is_publicobjectoptional
folder_slugobjectoptional

Responses

200application/json

Successful response

{
  "id": 1.5,
  "name": "string",
  "slug": "string",
  "icon": "string",
  "description": "string",
  "permission_name": "string",
  "is_active": true,
  "sort_order": 1.5,
  "is_system": true,
  "is_public": true,
  "options": "string",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z",
  "folder_slug": "string",
  "default_view_slug": "string",
  "default_view_type": "string"
}
idnumberrequired
namestringrequired
slugstringrequired
iconobjectrequired
descriptionobjectrequired
permission_nameobjectrequired
is_activebooleanrequired
sort_ordernumberrequired
is_systembooleanrequired
is_publicbooleanrequired
optionsobjectrequired
created_atstring · date-timerequired
updated_atstring · date-timerequired
folder_slugobjectrequired
default_view_slugobjectrequired
default_view_typeobjectrequired
400application/json

Bad request

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}
statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.

401application/json

Unauthorized

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}
statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.

500application/json

Internal server error

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}
statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.

Get one object by slug.< PreviousDelete an object and all of its records.Next >

Powered by heyo-docs

curl --request PUT \  'https://corteksa.info/api/v1/object/string' \  --header 'Content-Type: application/json' \  --data '{  "name": "string",  "description": "string",  "icon": "string",  "is_active": "string",  "is_public": "string",  "folder_slug": "string"}'
{
  "id": 1.5,
  "name": "string",
  "slug": "string",
  "icon": "string",
  "description": "string",
  "permission_name": "string",
  "is_active": true,
  "sort_order": 1.5,
  "is_system": true,
  "is_public": true,
  "options": "string",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z",
  "folder_slug": "string",
  "default_view_slug": "string",
  "default_view_type": "string"
}