Update person

PUT/api/people/{id}

Updates a person in the current workspace.

Path Parameters

id*string

Resource identifier.

Example"person_123"

Request Body

application/json

Request payload for Update person.

name?|

Human-readable name.

primaryEmail?|

Primary email address.

emailAddresses?array<>|

Email addresses associated with the resource.

description?|

Human-readable description.

customers?array<>|

Customers associated with the resource.

addresses?array<>|

Addresses associated with the resource.

jobTitle?|

job title.

phoneNumbers?array<>|

Phone numbers associated with the resource.

customFields?|

Custom field values stored for the person.

memberships?array<>|

Membership records associated with the resource.

[key: string]?never

Response Body

`application/json`

curl -X PUT "https://loading/api/people/person_123" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "person_123",
  "workspaceId": "ws_123",
  "createdAt": "2026-03-20T12:00:00.000Z",
  "updatedAt": "2026-03-20T12:05:00.000Z",
  "externalId": "crm_123",
  "data": {
    "name": "Ana Torres",
    "customers": [
      "customer_123"
    ]
  },
  "customFields": {
    "name": "Ana Torres",
    "customers": [
      "customer_123"
    ]
  },
  "name": "Ana Torres",
  "primaryEmail": "ana@example.com",
  "emailAddresses": [
    "ana@example.com"
  ],
  "description": "Procurement lead",
  "customers": [
    "customer_123"
  ],
  "customerNames": [
    "Acme SpA"
  ],
  "customerRelations": [
    {
      "id": "string",
      "label": "string",
      "contactLabel": "string"
    }
  ],
  "addresses": [
    "Av. Apoquindo 1234"
  ],
  "jobTitle": "Buyer",
  "phoneNumbers": [
    "+56 9 1234 5678"
  ],
  "memberships": [
    {
      "id": "string",
      "customerId": "string",
      "personId": "string",
      "roles": [
        "buyer"
      ],
      "isPrimary": true,
      "isActive": true,
      "label": "string",
      "person": {
        "id": "string",
        "name": "string",
        "primaryEmail": "user@example.com",
        "emailAddresses": [
          "string"
        ],
        "phoneNumbers": [
          "string"
        ],
        "jobTitle": "string"
      },
      "customer": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "primaryMembership": {
    "id": "string",
    "customerId": "string",
    "personId": "string",
    "roles": [
      "buyer"
    ],
    "isPrimary": true,
    "isActive": true,
    "label": "string",
    "person": {
      "id": "string",
      "name": "string",
      "primaryEmail": "user@example.com",
      "emailAddresses": [
        "string"
      ],
      "phoneNumbers": [
        "string"
      ],
      "jobTitle": "string"
    },
    "customer": {
      "id": "string",
      "name": "string"
    }
  }
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`