Sign in
Party

Update a Party as admin

Changed on

Delegated Aura access tokens require parties:write; missing scope returns 403 FORBIDDEN. Updates the name and/or contact information for a Party for an authenticated administrator.

Only name, phone, and email are supported. Omitted members remain unchanged; null clears phone or email; name is not nullable and name: null is rejected. Party names trim outer Unicode whitespace, reject blank values, and reject values over 255 UTF-8 bytes. Renaming a Party never changes its immutable slug.

The response is the resulting Party representation and uses Cache-Control: no-store because contact data is returned. An empty object is a valid no-op PATCH; an empty HTTP body is invalid.

patch/api/v1/admin/parties/{partyId}

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/admin/parties/{partyId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

partyIdstring required

Stable Party identifier.

Request body

namestring

Replacement Party name. Outer Unicode whitespace is trimmed; blank values, values over 255 UTF-8 bytes, and null are rejected.

phonestring nullable

Replacement Party phone number; null clears it.

emailstring email nullable

Replacement Party email address; null clears it.

Response

Party updated successfully.

partyIdstring required

Stable Party identifier.

partySlugIdstring required

Immutable Party slug identifier.

namestring required

Party name.

createdstring date-time required

When the Party was created.

updatedstring date-time required

When the Party was last updated.

Changes

  • 999eda3fdd63Revision changes
    • breaking

      the response's property format changed from uuid to no format for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      for the path request parameter partyId, the format was generalized from uuid to no format

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 96385058291dRevision changes
    • info

      endpoint added