Update an ACS User

• Request Parameters

• Response

• Examples

Updates the properties of a specified access system user.

Signature

PATCH /acs/users/update ⇒ void

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

acs_user_id (Required)

ID of the ACS user.

---

access_schedule

starts_at and ends_at timestamps for the access system user's access. If you specify an access_schedule, you may include both starts_at and ends_at. If you omit starts_at, it defaults to the current time. ends_at is optional and must be a time in the future and after starts_at.

---

email

---

email_address

Email address of the ACS user.

---

full_name

Full name of the ACS user.

---

hid_acs_system_id

---

phone_number

Phone number of the ACS user in E.164 format (for example, [phone]).

---

Response

void

---

Examples

Update an ACS user

Update the properties of a specific ACS user.

JavaScript

Code

await seam.acs.users.update({
  acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
  phone_number: "[phone]",
});

Output

// void

Python

Code

seam.acs.users.update(
    acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number="[phone]"
)

Output

None

Ruby

Code

seam.acs.users.update(
  acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
  phone_number: "[phone]",
)

Output

nil

PHP

Code

<?php
$seam->acs->users->update(
    acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
    phone_number: "[phone]"
);

Output

null

Seam CLI

Code

seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "[phone]"

Output

{}

Go

Code

package main

import api "github.com/seamapi/go"
import users "github.com/seamapi/go/users"

func main() {
	client.Acs.Users.Update(
		context.Background(),
		users.UsersUpdateRequest{
			AcsUserId:   api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
			PhoneNumber: api.String("[phone]"),
		},
	)
}

Output

nil

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/users/update" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_user_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
  "phone_number": "[phone]"
}
EOF

Output

{}