Upsert a list entry by parent

v1.0.0

Use this endpoint to create or update a list entry for a given parent record. If an entry with the specified parent record is found, that entry will be updated. If no such entry is found, a new entry will be created instead. If there are multiple entries with the same parent record, this endpoint with return the "MULTIPLE_MATCH_RESULTS" error. When writing to multi-select attributes, all values will be either created or deleted as necessary to match the list of values supplied in the request body.

Required scopes: list_entry:read-write, list_configuration:read.

Input

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "entry_values",
        "parent_object",
        "parent_record_id"
      ],
      "properties": {
        "entry_values": {
          "type": "object",
          "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types)."
        },
        "parent_object": {
          "type": "string",
          "description": "A UUID or slug identifying the object that the added parent record belongs to."
        },
        "parent_record_id": {
          "type": "string",
          "format": "uuid",
          "description": "A UUID identifying the record you want to add to the list. The record will become the 'parent' of the created list entry."
        }
      }
    },
    "list": {
      "type": "string",
      "description": "A UUID or slug of the list the list entry belongs to."
    }
  },
  "required": [
    "data",
    "list"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "created_at",
        "entry_values",
        "id",
        "parent_object",
        "parent_record_id"
      ],
      "properties": {
        "created_at": {
          "type": "string",
          "description": "When this entry was created."
        },
        "entry_values": {
          "type": "object",
          "description": "A list of attribute values for the list entry (not attribute values for its parent record)."
        },
        "id": {
          "type": "object",
          "required": [
            "entry_id",
            "list_id",
            "workspace_id"
          ],
          "properties": {
            "entry_id": {
              "type": "string",
              "format": "uuid",
              "description": "A UUID identifying this entry."
            },
            "list_id": {
              "type": "string",
              "format": "uuid",
              "description": "A UUID identifying the list this entry is in."
            },
            "workspace_id": {
              "type": "string",
              "format": "uuid",
              "description": "A UUID identifying the workspace this entry belongs to."
            }
          }
        },
        "parent_object": {
          "type": "string",
          "description": "A UUID or slug identifying the object that the parent record belongs to."
        },
        "parent_record_id": {
          "type": "string",
          "format": "uuid",
          "description": "A UUID identifying the record that is parent of the list entry."
        }
      }
    }
  }
}