Sign in
ListingSources

Update a ListingSource as admin

Changed on

Delegated Aura access tokens require listing-sources:write; missing scope returns 403 FORBIDDEN. Updates one ListingSource for an authenticated administrator.

listingSourceId must be a valid ListingSource ID. Omitted members remain unchanged; null clears only url, image, and referralConfiguration. name and ingestionConfiguration are non-nullable and cannot be cleared. Supplying ingestionConfiguration replaces the whole configuration list and its methods must match the ListingSource ingestion methods. A WooCommerce entry may omit webhookSecret only when WooCommerce is already configured; omission preserves the existing secret, a string rotates it, and null is invalid. An empty object is a valid no-op PATCH; an empty HTTP body is invalid.

Renaming a ListingSource never changes its immutable slug. The response contains only the stable ListingSource ID and slug. WooCommerce webhook secrets are write-only: they are never returned or logged.

patch/api/v1/admin/listing-sources/{listingSourceId}

Request

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

Path parameters

listingSourceIdstring required

Stable ListingSource identifier.

Request body

namestring

ListingSource name. Outer Unicode whitespace is trimmed; blank values and values over 255 UTF-8 bytes are rejected.

urlstring uri nullable
imagestring uri nullable

Response

ListingSource updated successfully.

listingSourceIdstring required
listingSourceSlugIdstring required

Example response

{
  "listingSourceSlugId": "ada-antiques"
}

Changes

  • b6962e36b828Revision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the / request property oneOf list

    • warning

      removed the request property

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the / request property oneOf list

  • 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 listingSourceId, 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