deliveryPromiseParticipantsUpdate

mutation

Requires write_delivery_promises access scope.

Updates the delivery promise participants by adding or removing owners based on a branded promise handle.

Arguments

Anchor to brandedPromiseHandlebrandedPromiseHandle • String!required: The branded promise handle to update the delivery promise participants for.
Anchor to ownersToAddownersToAdd • [ID!]Default:[]: The owners to add to the delivery promise participants.
Anchor to ownersToRemoveownersToRemove • [ID!]Default:[]: The owners to remove from the delivery promise participants.

Was this section helpful?

Anchor to DeliveryPromiseParticipantsUpdatePayload returnsDeliveryPromiseParticipantsUpdatePayload returns

Anchor to promiseParticipantspromiseParticipants • [DeliveryPromiseParticipant!]: The promise participants that were added.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation deliveryPromiseParticipantsUpdate($brandedPromiseHandle: String!, $ownersToAdd: [ID!], $ownersToRemove: [ID!]) {
2  deliveryPromiseParticipantsUpdate(brandedPromiseHandle: $brandedPromiseHandle, ownersToAdd: $ownersToAdd, ownersToRemove: $ownersToRemove) {
3    promiseParticipants {
4      # DeliveryPromiseParticipant fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "brandedPromiseHandle": "<your-brandedPromiseHandle>",
3  "ownersToAdd": [
4    "gid://shopify/<objectName>/10079785100"
5  ],
6  "ownersToRemove": [
7    "gid://shopify/<objectName>/10079785100"
8  ]
9}

{
  "brandedPromiseHandle": "<your-brandedPromiseHandle>",
  "ownersToAdd": [
    "gid://shopify/<objectName>/10079785100"
  ],
  "ownersToRemove": [
    "gid://shopify/<objectName>/10079785100"
  ]
}