Sign in
Survey data - Rest Services

Changed on

Update an external service.

patch/api/v2/assets/{uid_asset}/hooks/{uid_hook}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

uid_assetstring required

UID of the parent assets

uid_hookstring required

UID of the hook

Request body

activeboolean
assetinteger
auth_level'no_auth' | 'basic_auth'
  • no_auth - no_auth
  • basic_auth - basic_auth
date_modifiedstring date-time
email_notificationboolean
endpointstring
export_type'xml' | 'json'
  • xml - xml
  • json - json
failed_countinteger
logs_urlstring uri
namestring
payload_templatestring nullable
pending_countinteger
subset_fieldsstring[]
success_countinteger
uidstring
urlstring uri

Example request

{
  "logs_url": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/hooks/hZzzeedWxQoFHgibsTCysv/logs/",
  "url": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/"
}

Response

activeboolean
assetinteger required
auth_level'no_auth' | 'basic_auth'
  • no_auth - no_auth
  • basic_auth - basic_auth
date_modifiedstring date-time required
email_notificationboolean
endpointstring required
export_type'xml' | 'json'
  • xml - xml
  • json - json
failed_countinteger required
logs_urlstring uri required
namestring required
payload_templatestring nullable
pending_countinteger required
subset_fieldsstring[]
success_countinteger required
uidstring required
urlstring uri required

Example response

{
  "logs_url": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/hooks/hZzzeedWxQoFHgibsTCysv/logs/",
  "url": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/"
}

Changes

  • v2f55f5ce273d3Revision changes
    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)

  • v2f861bc35dbacRevision changes
    • breaking

      removed the required property from the response with the status