Syntax

Rename watchlist.

PUT /v{version}/users/{userId}/watchlists/{watchlistId}/name

Description

This API endpoint enables you to rename an existing watchlist

Parameters

TypeNameDescriptionSchemaDefault

Header

Authorization required

This is the authorization token that you retrieved from the first endpoint (/token).

string

Path

userId required

This is the internal identifier of the user whose watchlist needs to be renamed.

integer (int32)

Path

version required

This is the version of the API. Unless you have multiple versions of AutoShares’s API deployed in your environment, leave it at 1.0.

string

"1"

Path

watchlistId required

This is the internal identifier of the watchlist that must be renamed.

integer (int32)

Query

name required

This is the new name of the modified watchlist.

string

Responses

HTTP CodeDescriptionSchema

200

Successful request, in response you’ll receive the renamed watchlist’s ID and its new name.

401

The access level of the provided authorization token is not sufficient to perform this operation.

No Content

403

The provided Et-App-Key is incorrect.

No Content

409

The watchlist couldn’t be renamed due to some conflict.

No Content

422

A validation error occurred while processing the request.

No Content

500

Internal server error

No Content

Produces

  • application/json

  • text/json

Last updated