Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
114 lines (96 sloc) 8.26 KB

Update Setting

Update a setting for a given account.

HTTP Method

.. http:post:: /api/account/update_setting

Request Body Parameters — Required

Name Details
v Description The version of the API to use
Allowed Values 1
Example v=1
api_token Description The API token used for this session
Allowed Values Hex String
Example api_token=7ca5dc5c7cce449fb0fff719307e8f5f
setting Description The name of the setting to update
Allowed Values String
Example setting=default_job_notes
value Description The new value of the setting
Allowed Values String
Example value=true

Request Body Parameters — Optional

Name Details
account_id Description Username of a sub account for which to update setting
Allowed Values String
Example account_id=my_sub_account

Available Settings

default_job_notes
Description
Glossary to be used for all transcriptions. Examples include:
global job instructions (guidelines), terms, names, etc. to aid
in transcription for each job request.
Allowed Values String (6000 characters max)
require_customer_authorization_before_starting_workflow
Description Require all jobs to be authorized by the customer before being processed
Allowed Values Boolean
customer_authorization_required_mechanical
Description
Require Mechanical jobs to be authorized by the customer before
being processed. When set to false, this parameter overrides
require_customer_authorization_before_starting_workflow
parameter set to true. When set to true, this parameter
has no effect.
Allowed Values Boolean

Responses

HTTP Code Details
204 Description Success
Contents none
400 Description An error occurred
Contents Error description (see :ref:`error-format-label` for details)

Example Requests

POST /api/account/update_setting HTTP/1.1
Host: api.cielo24.com
Body: v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f&account_id=john_doe
      &setting=default_job_notes&value=my%20job%20notes

Example Response

HTTP/1.1 204 OK