Update a Credential

Updates the code and ends at date and time for a specified credential.

POST /acs/credentials/update

JavaScript

Seam SDK

await seam.acs.credentials.update({ acs_credential_id: "1d4fb22b-743b-492f-ad74-cffcbd63c874", code: "1234", ends_at: "2025-06-18T10:42:53.000Z", }); /* // void */

200

{
  "acs_credential": {
    "access_method": "code",
    "acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "errors": [
      {
        "error_code": "<string>",
        "message": "<string>"
      }
    ],
    "is_managed": true,
    "warnings": [
      {
        "error_code": "<string>",
        "message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_credential_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assa_abloy_vostio_metadata": {
      "auto_join": true,
      "door_names": [
        "<string>"
      ],
      "endpoint_id": "<string>",
      "key_id": "<string>",
      "key_issuing_request_id": "<string>",
      "override_guest_acs_entrance_ids": [
        "<string>"
      ]
    },
    "card_number": "<string>",
    "code": "<string>",
    "ends_at": "<string>",
    "external_type": "pti_card",
    "external_type_display_name": "<string>",
    "is_issued": true,
    "is_latest_desired_state_synced_with_provider": true,
    "is_multi_phone_sync_credential": true,
    "is_one_time_use": true,
    "issued_at": "2023-11-07T05:31:56Z",
    "latest_desired_state_synced_with_provider_at": "2023-11-07T05:31:56Z",
    "parent_acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "starts_at": "<string>",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visionline_metadata": {
      "card_function_type": "guest",
      "auto_join": true,
      "card_id": "<string>",
      "common_acs_entrance_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "credential_id": "<string>",
      "guest_acs_entrance_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_valid": true,
      "joiner_acs_credential_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  },
  "ok": true
}

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

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

Body

application/json

acs_credential_id · string · required

ID of the credential that you want to update.

code · string

Replacement access (PIN) code for the credential that you want to update.

Pattern: ^\d+$

ends_at · string<date-time>

Replacement date and time at which the validity of the credential ends, in ISO 8601 format. Must be a time in the future and after the starts_at value that you set when creating the credential.

Response

200

application/json

OK

acs_credential · object · required

Means by which an access control system user gains access at an entrance. The acs_credential object represents a credential that provides an ACS user access within an...

Show child attributes

ok · boolean · required