Records

Create a record

Creates a new person, company or other record. This endpoint will throw on conflicts of unique attributes. If you would prefer to update records on conflicts, please use the Assert record endpoint instead.

Required scopes: record_permission:read-write, object_configuration:read.

post/v2/objects/{object}/records

Path parameters

objectstring required

The UUID or slug identifying the object the created record should belong to.

Example:people

Request body

Example request

{
  "data": {
    "values": {
      "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value",
      "multiselect_attribute": [
        "Select option 1",
        "Select option 2"
      ]
    }
  }
}

Response

Success

Example response

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z"
  }
}

Changes

Changed in 2 of the 6 revisions of this API.11

    • added the new missing_value enum value to the code response property for the response status 400

      response-property-enum-value-added

    • the endpoint scheme security oauth2 was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog