---
title: "Set party handle"
method: PUT
path: "/parties/me/handle"
tags: ["Parties"]
---

# Set party handle

`PUT /parties/me/handle`

Set or rename your party's handle; it can never be cleared

## Headers

- `X-Agent-ID` string, nullable
- `X-Instance-ID` string, nullable

## Request body

- object
  - `data` object, required
    - `attributes` object, required
      - `handle` string, required — Party handle without the "@" prefix, such as "acme". Renames the handle; it cannot be cleared. For 14 days after a rename, only the same party can reclaim the released name.

## Response `200`

Successful Response

- object
  - `data` object, required
    - `id` string, required — Party ID (pty_*).
    - `type` 'party', required
    - `attributes` object, required
      - `partyType` 'PERSON' | 'ORG', required — Party type.
      - `legalName` string, nullable, required — Legal business name for `ORG` parties.
      - `firstName` string, nullable, required — Legal first name for `PERSON` parties.
      - `lastName` string, nullable, required — Legal last name for `PERSON` parties.
      - `status` 'PROVISIONAL' | 'ACTIVE' | 'SUSPENDED' | 'INACTIVE', required — Party status.
      - `createdAt` string, date-time, required — When the party was created.
      - `updatedAt` string, date-time, required — When the party was last updated.
      - `displayName` string, nullable, required — Display name for the party.
      - `handle` string, nullable, required — Party handle (e.g. "@acme"), or null when the party has not claimed one.
      - `avatarUrl` string, nullable, required — Public URL of the party's avatar image, or null when none is set.
      - `persona` 'INDIVIDUAL' | 'DEVELOPER', nullable, required — Party persona, when available.
      - `email` string, nullable, required — Party's primary contact email.
      - `primaryPhone` string, nullable, required — Party's primary phone number.
      - `addressLine1` string, nullable, required — Street address line 1.
      - `addressCity` string, nullable, required — City.
      - `addressState` string, nullable, required — State or province.
      - `addressPostalCode` string, nullable, required — Postal or ZIP code.
      - `addressCountry` string, nullable, required — Country code (e.g., US).
      - `createdBy` string, nullable, required — User who created this party (usr_*).

## Other responses

- `400` — Validation Error
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found. Returned when the resource does not exist, or when it exists but is not accessible to your account. The two cases are intentionally indistinguishable, so that resource IDs cannot be enumerated by probing.
- `409` — Conflict
- `422` — Validation Error
- `428` — Precondition Required
- `429` — Too Many Requests
- `500` — Internal Server Error
- `501` — Not Implemented
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/natural/apis/natural-api.md) · [All operations](https://skmtc.net/natural/apis/natural-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/natural/natural-api/versions/9561339ea461/schema)