Skip to navigation

Update Service Key

View as Markdown

Edits the details of a service key.

The changes are defined in the Body of the request. The productId is returned when you list the service keys.

Only include the parameters that you want to update. For a service key, you can update the following parameters:

  • singleUse - Determines whether the service key is single-use or multi-use. Valid values are true (single-use) and false (multi-use). With a multi-use key, the customer that you share the key with can request multiple connections using that key.

  • active - Determines whether the service key is available for use. Valid values are true if you want the key to be available right away and false if you don’t want the key to be available right away.

  • validFor - The range of dates for which the service key is valid. The dates are entered in UNIX timestamp date format. You can use tools such as https://www.epochconverter.com/ or https://it-tools.tech/date-converter to determine the correct value to enter.

Request

This endpoint expects an object.
activebooleanOptional
keystringOptional
productIddoubleOptional
singleUsebooleanOptional
validForobjectOptional

Response

Update Service Key / Update Service Key

dataobjectOptional
messagestringOptional
termsstringOptional