Mutations
Creating and modifying data on the AniList.
Last updated
Creating and modifying data on the AniList.
Last updated
allow you to create, update, and delete data. All mutations require authentication, so you will need to before you can use them.
::: tip Unlike queries, where you can exclude the query
keyword, mutations require the mutation
keyword. :::
The majority of our mutations have the following prefixes:
Save
: Create new or update existing data
We usually determine if you would like to create or update data depending on if you provide an id
or not.
Delete
: Delete data
This will usually return a object type. However, some mutations will return an updated version of the sibling data if this is more useful.
Toggle
: Toggle a boolean value
::: info Authorization needed In the examples below, you will also need to include your access token in the Authorization
header of your request. For the sake of brevity, we will be skipping that step here. :::
Let's create a new media list entry on our user's list. We'll use , which has an ID of 1
, as an example.
:::details Example Query
::: code-group
<<< @/guide/snippets/graphql/mutations/create/php.php{php:line-numbers} [PHP]
:::
The request in the above example will return the following JSON response:
Keep in mind that the id
that was returned is the ID of the newly created list entry.
Using the id
returned above, we can update the status of the list entry.
Note how the above mutation includes the $listEntryId
variable, which is used to identify the list entry to update. It went unused in the example above, but we can make use of it now.
If using the above studio link, you will need to replace the listEntryId
variable with the ID returned from the previous mutation.
::: code-group
<<< @/guide/snippets/graphql/mutations/update/php.php{php:line-numbers} [PHP]
:::
The request in the above example will return an identical response to the one above, but with the status
field updated to COMPLETED
.
:::details Example Query