Documentation

Updating your metadata

Because DOIs are designed to be persistent, a DOI string can’t be changed once registered, and DOIs cannot be deleted.

However, you can update metadata associated with your registered DOIs, and we encourage you to do this as often as required. No fees are charged for updating existing metadata records.

To add, change, or remove metadata from your existing records, you generally just need to resubmit your complete metadata record with the changes included.

There are a few exceptions where you can’t just resubmit your records using your chosen content registration method, or where there is an easier option, and you need to do something different:

Exceptions to standard metadata updates

  • Crossmark: if you want to update or replace (not just delete) metadata for Crossmark and your deposit method is web deposit form or direct deposit of XML, you can’t just resubmit the new information. Follow a two-step process to (1) actively delete the relevant metadata by redepositing the record but with the Crossmark field blank (markup example for users of direct deposit of XML), then (2) add the new Crossmark metadata in another redeposit.
  • Funding, license, and Similarity Check full-text URLs: you can add this metadata to multiple DOIs at once by uploading a csv file to the web deposit form using the supplemental metadata upload.
  • References can be added in a few different ways - learn more about adding references to your metadata record
  • Relationships: if you want to update or replace (not just delete) metadata for relationships and your deposit method is direct deposit of XML, you can’t just resubmit the new information. Follow a two-step process to (1) actively delete the relevant metadata by sending us a full redeposit but with the relationship field blank, then (2) add the new relationship metadata in another full redeposit.
  • Resolution URLs: you may update resolution URLs in bulk using a tab-separated .txt file. See full details below.
  • Titles: to update the title for a book, journal, or other content associated with an ISSN or ISBN, you will need to contact us as we may need to make some changes on our side.
  • Some non-bibliographic metadata may be updated, added to, or removed from a metadata record independently using a resource-only deposit. This might make things easier for those of you who send us XML files directly.

Updating bibliographic metadata by resubmitting your complete record

Most metadata changes can be done by resubmitting your complete metadata record, but there are some exceptions - please check the exceptions list above.

  • OJS: find the record you wish to update, leave the relevant field blank to delete it, or add in your new metadata to update it, and deposit it again using the Crossref import/export plugin. You must be running at least OJS 3.1.2 and have the Crossref import/export plugin enabled
  • Web deposit form: re-enter all the metadata including the changes - leave the relevant field blank to delete it, or add in your new metadata to update it - and resubmit
  • Still using the deprecated Metadata Manager?: search for the journal record you wish to update, leave the relevant field blank to delete it, or add in your new metadata to update it, and deposit it again. Learn more about metadata corrections, updates, and additions in Metadata Manager
  • Depositing XML files with Crossref: make changes to your XML file and resubmit it to Crossref. When making an update, you must supply all the bibliographic metadata for the record being updated, not just the fields that need to be changed. During the update process we overwrite the existing metadata with the new information you submit, and insert null values for any fields not supplied in the update. This means, for example, that if you’ve supplied an online publication date in your initial deposit, you’ll need to include that date in subsequent deposits if you wish to retain it. Note that the value included in the <timestamp> element must be incremented each time a DOI is updated.

Updating your resolution URLs

If your content moves and you need to update all of your URLs, you can update them in bulk to make sure that all your DOIs resolve to your content persistently.

Reasons for resource resolution URL updates

  • Platform migration: if you know that your URLs are going to need to be updated in the future as you’re planning a platform migration, use our handy guide and checklist to help you manage this effectively.
  • Title transfers: if you’ve acquired a title from another Crossref member, you’ll need to update your resolution URLs. Do make sure to also check the inherited metadata for other fields, as this may also need to be updated. Learn more about updating inherited DOIs and metadata after a title transfer.
  • No longer hosting the content: if the worst happens and you are no longer able to host your content, it’s invaluable to have an archive provider as a backup. We encourage all Crossref members to use best efforts to engage an archive provider, and to include information about archiving arrangements in their metadata.

How to update your resolution URLs

If you only have a few URLs to update, you can just resubmit your record.

If you have a long list of URLs that need updating (for example, you’ve just finished a platform migration, or you’ve acquired a new title), you can do a bulk resource URL update. Create a tab-separated list (formatted as a text (.txt) file) of DOIs and their new URLs, and apply the following header:

H: email=youremail@email.com;fromPrefix=10.xxxx

where youremail@email.com is your email address and 10.xxxx is the owner prefix (this should be the prefix associated with the username you’ll be processing this request with) for the DOIs you’re updating.

Only DOIs of the same owning prefix may be updated together using this header. For example, if you have DOIs against two owning prefixes, you’ll need to separate your submissions and use the appropriate 10.xxxx prefix for each set of your DOIs.

This is what your tab-separated list should look like:

H: email=youremail@email.com;fromPrefix=10.5555
10.5555/doi1   http://www.yourdomain.com/newurl1
10.5555/doi2   http://www.yourdomain.com/newurl2
10.5555/doi3   http://www.yourdomain.com/newurl3

You can upload the file to the admin tool or use the upload tool. To use the admin tool, login and navigate to Submissions>Upload. Upload your file, choose “Bulk URL Update” as the Type, and click Upload.

If you have more than 4,000 URLs to update, you should break them into smaller files. The file upload size limit for this operation is 400 KB.

We can provide a list of your existing DOIs and URLs if needed.

Updating title records

When a new journal, book, conference proceeding, standard, report, or dissertation is registered with Crossref, we create a title record in our database from the metadata provided in the submission. Titles associated with an ISSN or ISBN must be consistent from registration to registration (inconsistencies in title-level metadata submitted will lead to deposit errors). This means that if you need to change the title of a journal or a book, we will need to modify the title record in our system before you can update your metadata for that title.

Although members can’t edit titles once they have been deposited, our support team can do the following when necessary - please send us the details, and we’ll update the records:

  • Add or adjust ISSNs - correct ISSN errors or add additional ISSNs.
  • Add or adjust alternative spellings of titles - alternative title spellings and abbreviations are recorded for each title and used in query matching. They can be included in the <abbrev> elements, or we can add them for you.
  • Correct title spelling - we’ll need to correct these for you, please open a support ticket.
  • Merge titles - if two title entries have been created in error, we’ll merge the titles entries into one upon request.
  • Delete titles - titles submitted by mistake can be deleted, once the DOIs assigned to the title have been migrated to another title.

The adjustments above affect only the title record - you’ll also need to update your metadata for any existing content records related to this title to update the title within that metadata record.

Journal title and ISSN changes

The ISSN International Centre recommends applying for a new ISSN if the publication’s medium changes (for example, a print magazine becomes an online magazine), or if the publication’s title changes. A change of ISSN is not required for other changes such as change of publisher, publication location, frequency, editorial policy.

In the case of a significant title change, such as “The Journal of Things” to “International Journal of Important Stuff”, DOIs registered for the original title should stay associated with that title, and all new DOIs should be registered to the new title (and new ISSN and journal-title-level DOI).

For a minor title change, such as “The Journal of Things” to “Things Journal”, keep the existing ISSN and update the title record. Ask us to update the journal title record in our system, then you update all DOIs previously registered for this title. Once all records associated with that title have been updated to include the new title, the journal title in your submissions will match the one in our records, and no longer trigger deposit errors (such as “This error indicates the ISSN(s), title, or publisher in your deposit do not match the data we have on record for that ISSN”).

Page owner: Isaac Farley   |   Last updated 2022-May-20