deliveryPromiseParticipantsUpdate

mutation

Requires write_delivery_promises access scope.

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

Anchor to Arguments

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?

Examples

deliveryPromiseParticipantsUpdate reference

Mutation Reference

mutation deliveryPromiseParticipantsUpdate($brandedPromiseHandle: String!, $ownersToAdd: [ID!], $ownersToRemove: [ID!]) {

deliveryPromiseParticipantsUpdate(brandedPromiseHandle: $brandedPromiseHandle, ownersToAdd: $ownersToAdd, ownersToRemove: $ownersToRemove) {

promiseParticipants {

# DeliveryPromiseParticipant fields

}

userErrors {

field

message

}

Input

{

"brandedPromiseHandle": "<your-brandedPromiseHandle>",

"ownersToAdd": [

"gid://shopify/<objectName>/10079785100"

"ownersToRemove": [

"gid://shopify/<objectName>/10079785100"

]

}

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