POST
/
api
/
v1
/
sov
/
{sovid}
/
initiate_update
Initiate SOV Update Job
curl --request POST \
  --url https://api.sovfixer.com/api/v1/sov/{sovid}/initiate_update \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "update_type": "SCRUB",
  "callback_url": "<string>",
  "client_ref": "<string>"
}'
{
  "message": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
sovid
string
required

Body

​
update_type
enum<string>

Optional.

  • SCRUB - SCRUB
  • AIR - AIR
  • RMS - RMS
  • RMS_ANALYSIS - RMS_ANALYSIS
  • API - API
  • COMPLETE - COMPLETE
  • PINGREADY - PINGREADY
Available options:
SCRUB,
AIR,
RMS,
RMS_ANALYSIS,
API,
COMPLETE,
PINGREADY
​
callback_url
string<uri>

Optional webhook URL for POSTing results. If provided, results will be provided upon completion in the same format as the GET /sov/update/{id} response.

Minimum length: 1
​
client_ref
string

Optional user reference identifier, usable for any purpose.

Minimum length: 1

Response

​
message
string
required

API Message.

​
id
string
required

Newly-created SOV Update ID. Use this as the id for future requests.