Skip to main content
PUT
/
parties
/
{party_id}
Update party
curl --request PUT \
  --url https://api.natural.co/parties/{party_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "legal_name": null,
      "display_name": "Natural Updated",
      "legal_id": null,
      "primary_email": "new-contact@natural.co",
      "primary_phone": null,
      "address_line1": null,
      "address_city": null,
      "address_state": null,
      "address_postal_code": null,
      "address_country": null,
      "status": null,
      "kyc_status": null
    }
  }
}
'
{
  "data": {
    "type": "party",
    "id": "pty_019cd1798d617f65a79cb965dda9eac3",
    "attributes": {
      "party_type": "ORG",
      "legal_name": "Natural AI, Inc",
      "display_name": "Natural",
      "status": "ACTIVE",
      "kyc_status": "VERIFIED",
      "kyc_verified_at": "2024-01-15T10:30:00Z",
      "primary_email": "contact@natural.co",
      "primary_phone": "+1-555-0100",
      "address_line1": "123 Main Street",
      "address_city": "San Francisco",
      "address_state": "CA",
      "address_postal_code": "94105",
      "address_country": "US",
      "created_by": null,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

​
X-Instance-ID
string | null

Agent session/conversation ID for observability.

Maximum string length: 1024

Path Parameters

​
party_id
string
required

Body

application/json

Request body for updating a party (JSON:API).

​
data
PartyUpdateData · object
required

Resource object

Response

Successful Response

Single party response.

​
data
PartyResource · object
required

Resource object