Skip to main content
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 '
{
  "callback_url": "<string>",
  "client_ref": "<string>",
  "username": "<string>"
}
'
{
  "id": "<string>",
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
sovid
string
required

Body

​
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 string length: 1
​
client_ref
string

Optional user reference identifier, usable for any purpose.

Minimum string length: 1
​
update_type
enum<string>
  • SCRUB - Scrubber Reoutput
  • AIR - AIR Exports
  • RMS - RMS Exports
  • RMS_ANALYSIS - RMS Analysis
  • API - API Reoutput
  • COMPLETE - Scrubbing Complete
  • PINGREADY - Ping Ready
  • READY_FOR_REVIEW - Ready for Review
  • PRECERTIFIED - Clone Pre-Certified
  • MODELING_FILES_CREATED - Modeling Files Created
Available options:
SCRUB,
AIR,
RMS,
RMS_ANALYSIS,
API,
COMPLETE,
PINGREADY,
READY_FOR_REVIEW,
PRECERTIFIED,
MODELING_FILES_CREATED
​
username
string

Optional username for audit purposes.

Minimum string length: 1

Response

​
id
string
required

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

​
message
string
required

API Message.