Suspending and Unsuspending Users

Learn how to make temporary access changes by suspending or unsuspending users.

You can suspend a user to revoke their access temporarily. Suspending a user is a good action to take for users who may be behind on payment or have not fulfilled the requirements for entry. Then, once the user rectifies the payment, requirements, or other deficiency, you can unsuspend the user to restore their access.

---

Suspend a User

To suspend a user, provide the user ID (acs_user_id).

Python

Request:

seam.acs.users.suspend(
  acs_user_id="33333333-3333-3333-3333-333333333333"
)

Response:

None

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/acs/users/suspend' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333"
}'

Response:

{
  "ok": true
}

JavaScript

Request:

await seam.acs.users.suspend({
  acs_user_id: "33333333-3333-3333-3333-333333333333"
});

Response:

void

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->users->suspend(
  acs_user_id: "33333333-3333-3333-3333-333333333333"
);

Response:

void

C#

Request:

seam.UsersAcs.Suspend(
  acsUserId: "33333333-3333-3333-3333-333333333333",
);

Response:

void

Java

Request:

// Coming soon!

Response:

// Coming soon!

Go

Request:

suspend, uErr := client.Acs.Users.Suspend(
  context.Background(), &acs.UsersSuspendRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
  },
);

Response:

{
  "ok": true
}

---

Unsuspend a User

To unsuspend a user, provide the user ID (acs_user_id).

Python

Request:

seam.acs.users.unsuspend(
  acs_user_id="33333333-3333-3333-3333-333333333333"
)

Response:

None

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/acs/users/unsuspend' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333"
}'

Response:

{
  "ok": true
}

JavaScript

Request:

await seam.acs.users.unsuspend({
  acs_user_id: "33333333-3333-3333-3333-333333333333"
});

Response:

void

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->users->unsuspend(
  acs_user_id: "33333333-3333-3333-3333-333333333333"
);

Response:

void

C#

Request:

seam.UsersAcs.Unsuspend(
  acsUserId: "33333333-3333-3333-3333-333333333333"
);

Response:

void

Java

Request:

// Coming soon!

Response:

// Coming soon!

Go

Request:

unsuspend, uErr := client.Acs.Users.Unsuspend(
  context.Background(), &acs.UsersUnsuspendRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
  },
);

Response:

{
  "ok": true
}