Skip to main content
PUT
/
v1
/
core
/
users
/
{id}
Update user
curl --request PUT \
  --url https://api.example.com/v1/core/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "phoneNumber": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "memberTeamId": "<string>",
  "disabled": true,
  "billable": true,
  "contactSettings": {
    "suppressEmails": true,
    "suppressEmailErrors": false
  },
  "organizationId": "<string>"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "organizationId": "<string>",
  "phoneNumber": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "memberTeamId": "<string>",
  "coachTeamIds": [
    "<string>"
  ],
  "externalId": "<string>",
  "createdAt": "<string>",
  "disabled": true,
  "billable": true,
  "contactSettings": {
    "suppressEmails": true,
    "suppressEmailErrors": false
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
email
string

The user's email

​
phoneNumber
string

The user's phone number.

​
firstName
string

The user's first name.

​
lastName
string

The user's last name.

​
memberTeamId
string

The 6 digit code for the user's team. Strongly suggested to add this.

​
disabled
boolean

This field is true for users who are no longer a part of your organization or no longer using Siro.

​
billable
boolean

Whether the user is billable and should be included in the license count

​
contactSettings
object

Contact settings for the user

​
organizationId
string

Organization ID of the user

Response

200 - application/json

Update user

​
id
string
required
​
email
string | null
required
​
organizationId
string
required
​
phoneNumber
string | null
required
​
firstName
string | null
required
​
lastName
string | null
required
​
memberTeamId
string | null
required
​
coachTeamIds
string[]
required
​
externalId
string | null
required
​
createdAt
string | null
required
​
disabled
boolean
required
​
billable
boolean
required
​
contactSettings
object

Contact settings for the user