Update a User

Update the properties of a specified ACS user

Updates any of the following properties of a specified ACS user:

  • full_name

  • email_address

  • phone_number

  • access_schedule

/acs/users/update

post

Updates the properties of a specified access system user.

Authorizations
Body
acs_user_idstring · uuidOptional

ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.

user_identity_idstring · uuidOptional

ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.

acs_system_idstring · uuidOptional

ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.

full_namestring · min: 1Optional

Full name of the access system user.

emailstring · emailOptionalDeprecated
phone_numberstringOptional

Phone number of the access system user in E.164 format (for example, +15555550100).

email_addressstring · emailOptional

Email address of the access system user.

hid_acs_system_idstring · uuidOptional
Responses
200
OK
application/json
post
POST /acs/users/update HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Key
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "access_schedule": {
    "starts_at": "2025-07-01T04:59:27.119Z",
    "ends_at": "2025-07-01T04:59:27.119Z"
  },
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "full_name": "text",
  "phone_number": "text",
  "email_address": "[email protected]",
  "hid_acs_system_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "ok": true
}

Request

Specify the desired ACS user by including the corresponding acs_user_id in the request body. In addition, in the request body, include the properties that you want to update, along with the desired replacement values.

Request Body Parameters

Parameter
Type
Description

acs_user_id

String (UUID) Required

ID of the desired ACS user

full_name

String Optional

Replacement full name for the ACS user

email_address

String Optional

Replacement email address for the ACS user

phone_number

String Optional

Replacement phone number for the ACS user in E.164 format (for example, +15555550100)

access_schedule

Object Optional

Replacement starts_at and ends_at dates/times for the ACS user's access

Sample Request

seam.acs.users.update(
  acs_user_id="33333333-3333-3333-3333-333333333333",
  full_name="Jack Doe",
  email_address="[email protected]",
  phone_number="+15555550101",
  access_schedule={
    "starts_at": "2024-04-01T10:40:00Z",
    "ends_at": "2024-04-04T10:40:00Z"
  }
)

Response

Returns a Boolean ok status indicator or void.

Sample Response

None

Last updated

Was this helpful?

Revision created

Merge branch 'main' into beta