Update an Access Grant

Early Access Preview. The Access Grants API is currently in Alpha. We're actively developing it and seeking early feedback at [email protected]. Expect breaking changes as we refine the design.

• Request Parameters

• Response

Updates an existing Access Grant's time window.

JavaScript

Updates an existing Access Grant's time window.

Code:

await seam.accessGrants.update({
  access_grant_id: "4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1",
  starts_at: "2025-06-19T18:01:32.000Z",
  ends_at: "2025-06-22T13:24:50.000Z",
});

Output:

// void

cURL

Updates an existing Access Grant's time window.

Code:

curl --include --request POST "https://connect.getseam.com/access_grants/update" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "access_grant_id": "4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1",
  "starts_at": "2025-06-19T18:01:32.000Z",
  "ends_at": "2025-06-22T13:24:50.000Z"
}
EOF

Output:

{}

Python

Updates an existing Access Grant's time window.

Code:

seam.access_grants.update(
    access_grant_id="4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1",
    starts_at="2025-06-19T18:01:32.000Z",
    ends_at="2025-06-22T13:24:50.000Z",
)

Output:

None

Ruby

Updates an existing Access Grant's time window.

Code:

seam.access_grants.update(
  access_grant_id: "4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1",
  starts_at: "2025-06-19T18:01:32.000Z",
  ends_at: "2025-06-22T13:24:50.000Z",
)

Output:

nil

PHP

Updates an existing Access Grant's time window.

Code:

$seam->access_grants->update(
    access_grant_id: "4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1",
    starts_at: "2025-06-19T18:01:32.000Z",
    ends_at: "2025-06-22T13:24:50.000Z"
);

Output:

Seam CLI

Updates an existing Access Grant's time window.

Code:

seam access-grants update --access_grant_id "4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1" --starts_at "2025-06-19T18:01:32.000Z" --ends_at "2025-06-22T13:24:50.000Z"

Output:

{}

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

access_grant_id String (Required)

ID of the Access Grant to update.

---

ends_at String

Date and time at which the validity of the grant ends, in ISO 8601 format. Must be a time in the future and after starts_at.

---

name String

Display name for the access grant.

---

starts_at String

Date and time at which the validity of the grant starts, in ISO 8601 format.

---

Response

void