Sign in
Integration Credential

Update integration credential

Update an integration credential object. The whole secret is replaced — there is no per-key merge. The type cannot be changed.

put/api/v1/integration_credentials/{integrationCredentialID}

Path parameters

integrationCredentialIDinteger required

A unique integer value identifying this integration credential.

Request body

idinteger

Integration credential object ID.

urlstring uri

Integration credential object URL.

namestring

Name of the integration credential shown in the UI.

type'coupa_sand_oauth2'

Type of the credential; determines the shape of secret. Cannot be changed after creation.

hooksstring[]

Hooks that use this credential.

organizationstring uri

Organization URL.

created_bystring uri

User who created the integration credential.

created_atstring date-time

Timestamp of the integration credential creation.

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

Example request

{
  "id": 42,
  "url": "https://example.rossum.app/api/v1/integration_credentials/42",
  "name": "Acme Corp — Coupa prod",
  "type": "coupa_sand_oauth2",
  "secret": {
    "client_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "client_secret": "s3cr3t-value",
    "base_api_url": "https://example.coupahost.com",
    "scope": "core.invoice.create core.common.read"
  },
  "hooks": [
    "https://example.rossum.app/api/v1/hooks/1500"
  ],
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "created_by": "https://example.rossum.app/api/v1/users/9524",
  "created_at": "2026-01-01T15:02:25.653324Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Response

OK

idinteger required

Integration credential object ID.

urlstring uri required

Integration credential object URL.

namestring required

Name of the integration credential shown in the UI.

type'coupa_sand_oauth2' required

Type of the credential; determines the shape of secret. Cannot be changed after creation.

hooksstring[] required

Hooks that use this credential.

organizationstring uri required

Organization URL.

created_bystring uri required

User who created the integration credential.

created_atstring date-time required

Timestamp of the integration credential creation.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 42,
  "url": "https://example.rossum.app/api/v1/integration_credentials/42",
  "name": "Acme Corp — Coupa prod",
  "type": "coupa_sand_oauth2",
  "secret": {
    "client_id": "[redacted...]",
    "client_secret": "[redacted...]",
    "base_api_url": "https://example.coupahost.com",
    "scope": "core.invoice.create core.common.read"
  },
  "hooks": [
    "https://example.rossum.app/api/v1/hooks/1500"
  ],
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "created_by": "https://example.rossum.app/api/v1/users/9524",
  "created_at": "2026-01-01T15:02:25.653324Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.