Skip to navigation
Gift ProcessingSources

Update a Source

Updates a custom source. Canonical sources are read-only; a PATCH on one returns 403 Forbidden.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The unique identifier for the source.

Request

The request to update a custom source. Only the fields explicitly present in the request body are changed; omitted fields are left as-is.

namestringOptional

The human-readable name of the source.

Response

The updated source.
idstringRead-only
The unique identifier for the source.
namestring

The human-readable name of the source.

scopeenumRead-only

Who owns this source.

  • canonical — maintained by Chariot and shared across every organization. Read-only.
  • custom — created by an organization for its own use, and mutable by that organization.
Allowed values:
created_atdatetimeRead-only
When this source was added to the directory.
updated_atdatetimeRead-only
When this source was last modified.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error