Sign in
Records

Assert a record

Use this endpoint to create or update people, companies and other records. A matching attribute is used to search for existing records. If a record is found with the same value for the matching attribute, that record will be updated. If no record with the same value for the matching attribute is found, a new record will be created instead. If you would like to avoid matching, please use the Create record endpoint.

If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.

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

put/v2/objects/{object}/records

Path parameters

objectstring required

A UUID or slug to identify the object the record should belong to.

Example:people

Query parameters

matching_attributestring required

The ID or slug of the attribute to use to check if a record already exists. The attribute must be unique.

Example:41252299-f8c7-4b5e-99c9-4ff8321d2f96

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

  • d2afbdc49fbc1See the full diff
    • ●

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

      response-property-enum-value-added

  • 4ce2c28668d41See the full diff
    • ○

      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