If you need to upload a files (e.g. photos, movies, audio, PDFs, ...) then use this endpoint to send a binary stream to the Datapoint within the integration. Unlike /v1/data-silo, this uploads to one datapoint only, rather than several at once.
POST
/v1/datapointIn your request headers, pass authorization: Bearer <<token>>.
If you're self-hosting Sombra, also add the request header x-sombra-authorization: Bearer <<sombraInternalKey>>. You can read more about request authorization here.
Requires scope:
API Key must be associated to this integration
authorizationstringAn API key generated from the Transcend dashboard: https://app.transcend.io/infrastructure/api-keys. |
x-sombra-authorizationstringThe Sombra internal key. This header is only needed for self-hosted Sombra gateways. See https://docs.transcend.io/docs/dsr-automation/api-integration/authentication#authenticating-to-sombra |
x-transcend-noncestringA reusable token sent in Transcend's webhook for this job, and returned by you when uploading the result of this job back to Transcend. Called a 'nonce' for legacy reasons, but is actually reusable. |
x-transcend-datapoint-namestringThe Datapoint to upload this file to (e.g. profile_picture). The keys should match a datapoint key you defined for this integration. |
x-transcend-profile-idstring[DEPRECATED] The profile identifier that is being reported. You should not use this header if you are using multi tenant Sombra or have a Sombra version at or above 7.182.0. For recent versions of Sombra, the profile identifier is encoded within the nonce. |
x-transcend-remote-idstringOptional: the name of the file that will be downloaded. If not provided, defaults to the "{datapoint name} (#)". |
x-transcend-skip-status-updatebooleandefault:falseIf true, the status of the Datapoint will not automatically update to "resolved" after you upload a file. This is useful when uploading multiple files to a Datapoint. Set this to false on your final upload to update the status of the Datapoint to "resolved". |
200 (OK)
application/jsonYour request was received without an issue.
400 (Bad Request)
application/jsonWhile this request passed authentication, the input is malformed. Please double-check that your code conforms to our API specification.
401 (Unauthorized)
application/jsonThere was a problem authenticating your request. This may be an issue with the Transcend API key ("authorization" header), or the Sombra API key ("x-sombra-authorization" header used for self-hosted gateways only).
413 (Request Entity Too Large)
application/jsonThe request body is too large. JSON and raw bodies must be less than 50MB. URL encoded bodies must be less than 30MB.
429 (Too Many Requests)
application/jsonYou are sending requests too quickly and have hit our rate limit. If you hit this, you'll need to throttle your request velocity or try again later.
Response Headers
Retry-Afterinteger |
X-RateLimit-Limitinteger |
X-RateLimit-Remaininginteger |
X-RateLimit-Resetinteger |
500 (Internal Server Error)
application/jsonA 5xx error means there is either an issue with your self-hosted gateway, or a Transcend server is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.
502 (Bad Gateway)
application/jsonAn upstream service on Transcend's side is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.