thirdUserDelete

mutation

Requires unauthenticated_write_message access scope.

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Delete a specified third-party user from a chat app or messaging system. Before you call this mutation, ensure that the third-party user has been created using the thirdUserCreate mutation.

Arguments

input ● ThirdUserDeleteInput

The input fields to delete a third-party user.

Return

success ● Boolean

Whether the deletion was successful.

userErrors ● [ThirdUserUserError!]!non-null

Errors related to the user information.

userId ● ID

ID of the third-party user.

Status and error codes

For detailed information about common codes, see Status and error codes.

Example

Delete a third-party user

Code

mutation ThirdUserDelete {
    thirdUserDelete(input: { userId: "gid://shopline/ThirdUser/******5235111" }) {
        success
        userId
        userErrors {
            code
            field
            message
        }
    }
}

Response

{
	"thirdUserDelete": {
		"success": true,
		"userErrors": [],
		"userId": "gid://shopline/ThirdUser/******5235111"
	}
}

Was this article helpful to you?

SHOPLINE

Legal