Sign in

v1

latestOpenAPI 3.1.02026-07-14402976.1 KB
Workspaces

Update a workspace Record

Use this endpoint to update workspace records by record_id. If the update payload includes multiselect attributes, the values supplied will be created and prepended to the list of values that already exist (if any). Use the Assert workspace endpoint to overwrite or remove multiselect attribute values.

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

patch/v2/objects/workspaces/records/{record_id}

Path parameters

record_idstring required

A UUID of the workspace record to update.

Example:72ef5feaf-4919-4208-b332-1339ab8ba040

Request body

Example request

{
  "data": {
    "values": {
      "workspace_id": "123",
      "name": "Customer.com",
      "avatar_url": "https://example.com/avatar.png",
      "users": [
        {
          "target_object": "users",
          "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1"
        }
      ],
      "company": {
        "target_object": "companies",
        "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab"
      }
    }
  }
}

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",
    "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b",
    "values": {
      "workspace_id": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "123",
          "attribute_type": "text"
        }
      ],
      "name": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "Fundstack",
          "attribute_type": "text"
        }
      ],
      "users": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "users",
          "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1",
          "attribute_type": "record-reference"
        }
      ],
      "company": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "target_object": "companies",
          "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab",
          "attribute_type": "record-reference"
        }
      ],
      "avatar_url": [
        {
          "active_from": "2023-01-01T15:00:00.000000000Z",
          "active_until": null,
          "created_by_actor": {
            "type": "system",
            "id": null
          },
          "value": "https://example.com/avatar.png",
          "attribute_type": "text"
        }
      ]
    }
  }
}