Syntax

Create price alert

POST /v{version}/users/{userId}/pricealerts

Description

This API endpoint enables you to create a new price alert.

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 on whose behalf a new price alert will be created.

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"

Body

body required

This is JSON data that contains information about the new price alert.

Responses

HTTP CodeDescriptionSchema

200

Successful request, the price alert has been successfully created.

401

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

No Content

409

The body of the request is lacking one of the required parameters

No Content

422

A validation error occurred while processing the request.

No Content

500

Internal server error

No Content

Consumes

  • application/json

  • text/json

Produces

  • application/json

  • text/json

Last updated