abandonmentEmailStateUpdate

mutationDeprecated

Requires write_marketing_events access scope.

Updates the email state value for an abandonment. Use abandonmentUpdateActivitiesDeliveryStatuses instead.

Arguments

Anchor to emailSentAtemailSentAt • DateTime: The date and time for when the email was sent, if that is the case.
Anchor to emailStateemailState • AbandonmentEmailState!required: The new email state of the abandonment.
Anchor to emailStateChangeReasonemailStateChangeReason • String: The reason why the email was or was not sent.
Anchor to idid • ID!required: The ID of the abandonment that needs to be updated.

Was this section helpful?

Anchor to AbandonmentEmailStateUpdatePayload returnsAbandonmentEmailStateUpdatePayload returns

Anchor to abandonmentabandonment • Abandonment: The updated abandonment.
Anchor to userErrorsuserErrors • [AbandonmentEmailStateUpdateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation abandonmentEmailStateUpdate($emailSentAt: DateTime, $emailState: AbandonmentEmailState!, $emailStateChangeReason: String, $id: ID!) {

abandonmentEmailStateUpdate(emailSentAt: $emailSentAt, emailState: $emailState, emailStateChangeReason: $emailStateChangeReason, id: $id) {

abandonment {

# Abandonment fields

}

userErrors {

field

message

}

Input

{

"emailSentAt": "2019-09-07T15:50:00Z",

"emailState": "NOT_SENT",

"emailStateChangeReason": "<your-emailStateChangeReason>",

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

}

{
  "emailSentAt": "2019-09-07T15:50:00Z",
  "emailState": "NOT_SENT",
  "emailStateChangeReason": "<your-emailStateChangeReason>",
  "id": "gid://shopify/<objectName>/10079785100"
}