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

POSThttps://connect.getseam.com/acs/users/update

Authorization

api_keypat_with_workspaceconsole_session

Body

application/json

access_scheduleobject

acs_user_id*string (uuid)

full_namestring

emailstring (email)

---
deprecated: use email_address.
---

phone_numbernullable string

email_addressstring (email)

hid_acs_system_idstring (uuid)

Response

200400401

OK

Body

application/json

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/acs/users/update', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acs_user_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "ok": false
}

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, [phone])
access_schedule	Object Optional	Replacement starts_at and ends_at dates/times for the ACS user's access

Sample Request

Python

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

cURL (bash)

curl -X 'POST' \
  "https://connect.getseam.com/acs/users/update" \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "full_name": "Jack Doe",
  "email_address": "[e-mail]",
  "phone_number": "[phone]",
  "access_schedule": {
    "starts_at": "2024-04-01T10:40:00Z",
    "ends_at": "2024-04-04T10:40:00Z"
  }
}'

JavaScript

await seam.acs.users.update({
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  full_name: "Jack Doe",
  email_address: "[e-mail]",
  phone_number: "[phone]",
  access_schedule: {
    "starts_at": "2024-04-01T10:40:00Z",
    "ends_at": "2024-04-04T10:40:00Z"
  }
});

Ruby

# Coming soon!

PHP

$seam->acs->users->update(
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  full_name: "Jack Doe",
  email_address: "[e-mail]",
  phone_number: "[phone]",
  access_schedule: array(
    "starts_at" => "2024-04-01T10:40:00Z",
    "ends_at" => "2024-04-04T10:40:00Z"
  )
);

C#

seam.UsersAcs.Update(
  acsUserId: "33333333-3333-3333-3333-333333333333",
  fullName: "Jack Doe",
  emailAddress: "[e-mail]",
  phoneNumber: "[phone]",
  accessSchedule: new Dictionary<string, string>()
    {
      {"starts_at", "2024-04-01T10:40:00Z"},
      {"ends_at", "2024-04-04T10:40:00Z"}
    }
);

Java

// Coming soon!

Go

startsAt, err := time.Parse(time.RFC3339, "2024-04-01T10:40:00Z")
endsAt, err := time.Parse(time.RFC3339, "2024-04-04T10:40:00Z")
if err != nil {
  return err
}

acs_user, uErr := client.Acs.Users.Update(
  context.Background(), &acs.UsersUpdateRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
    FullName: api.String("Jack Doe"),
    EmailAddress: api.String("[e-mail]"),
    PhoneNumber: api.String("[phone]"),
    AccessSchedule: &acs.UsersCreateRequestAccessSchedule{
      StartsAt: startsAt,
      EndsAt: endsAt,
    },
  },
)

Response

Returns a Boolean ok status indicator or void.

Sample Response

Python

None

cURL (bash)

{
  "ok": true
}

JavaScript

void

Ruby

# Coming soon!

PHP

void

C#

void

Java

// Coming soon!

Go

{
  "acs_user": {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "display_name": "Jack Doe",
    "full_name": "Jack Doe",
    "email": "[e-mail]",
    "email_address": "[e-mail]",
    "phone_number": "[phone]",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-04-02T09:53:26.421Z",
    "is_suspended": false,
    "user_identity_id": "22222222-2222-2222-2222-222222222222"
  },
  "ok": true
}