Updating Resources (PATCH)

How to update JSON:API resources using DrupalClient.

⚠️

The updateResource helper is available in next-drupal ^1.4.0.

The DrupalClient ships with a updateResource method for updating JSON:API resources.

updateResource

Update Resource

const article = await drupal.updateResource(
  "node--article",
  "a937dd34-5407-4fff-8594-fccaaa5bb72a", // <-- Article ID
  {
    data: {
      attributes: {
        title: "Title of Article",
      },
    },
  }
)

Update Resource with Relationships

const article = await drupal.updateResource(
  "node--article",
  "a937dd34-5407-4fff-8594-fccaaa5bb72a",
  {
    data: {
      attributes: {
        title: "Title of Article",
      },
      relationships: {
        field_media_image: {
          data: {
            type: "media--image",
            id: media.id,
          },
        },
      },
    },
  }
)

See the API reference for updateResource.

Authentication

To make authenticated requests when updating resources, use the withAuth option.

See the authentication docs for the supported authentication methods.

const article = await drupal.updateResource(
  "node--article",
  "a937dd34-5407-4fff-8594-fccaaa5bb72a",
  {
    data: {
      attributes: {
        title: "Title of Article",
      },
    },
  },
  {
    withAuth: // <-- Your auth method here.
  }
)
Creating Resources (POST)Deleting Resources (DELETE)