PATCH
/
sources
/
{id}

Authorizations

Authorization
string
headerrequired

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Path Parameters

id
string
required

Body

application/json
display_name
default: {"__typename":"Undefined"}
Required string length: 1 - 100
is_public
default: {"__typename":"Undefined"}

If the source document should be publicly available on the Registry once credits are issued.

published_at
default: {"__typename":"Undefined"}
supplier_reference_id
default: {"__typename":"Undefined"}
Maximum length: 100

Response

200 - application/json
display_name
string | null
required
id
string
required
Required string length: 20 - 36
is_public
boolean
required

This field indicates Whether or not this source document will be public on the Registry once Credits are issued referencing it.

published_at
string | null
required
supplier_reference_id
string | null
required
type
enum<string>
required
Available options:
DOCUMENT
url_info
object | null
required

URL info for the source, that varies depending on if it is public or private

Was this page helpful?

Post SourceDelete Source