deliveryPromiseParticipantsUpdate

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

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the deliveryPromiseParticipantsUpdate action (under Delivery).
Fill in the fields below, then reference the result from later steps as {{deliverypromiseparticipantsupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation DeliveryPromiseParticipantsUpdate($brandedPromiseHandle: String!, $ownersToAdd: [ID!], $ownersToRemove: [ID!]) {
  deliveryPromiseParticipantsUpdate(
    brandedPromiseHandle: $brandedPromiseHandle
    ownersToAdd: $ownersToAdd
    ownersToRemove: $ownersToRemove
  ) {
    promiseParticipants {
      id
      owner
      ownerType
    }
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

brandedPromiseHandlestringrequired

The branded promise handle to update the delivery promise participants for.

ownersToAddarray<string>

The owners to add to the delivery promise participants.

ownersToRemovearray<string>

The owners to remove from the delivery promise participants.

json

{
  "brandedPromiseHandle": "string",
  "ownersToAdd": [
    "string"
  ],
  "ownersToRemove": [
    "string"
  ]
}

Response

Read the result with {{deliverypromiseparticipantsupdate.response.data.data.deliveryPromiseParticipantsUpdate}}. If the API returns errors, the step fails and they are at {{deliverypromiseparticipantsupdate.response.data.errors}}.

promiseParticipantsarray<object>

idobject

ownerobject

ownerTypeobject

userErrorsarray<object>

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?