We are currently transitioning our API documentation to Apidog and making changes to improve standardization, and as such, methods are subject to change.

/user

Designing

PUT

/user

Last modified:2024-12-11 16:14:10

Update info for the currently-logged-in user and return the user's info after changes.
This method must be requested using POST and will fail with GET.

Request

Body Params application/x-www-form-urlencoded

name

string

optional

Your real name or superhero alias if you prefer. Example: Jeff Goldblum.

slack_member_id

string

optional

Slack member id (not the same as username). Example: U14UASKXY.

phone_number

string

optional

Phone number. Example: +1 212 456 1414.

email_alerts

string

optional

Whether to receive alerts by email. Example: true/false.

seen_card_anomalies

string

optional

N/a. Example: true/false.

seen_card_matches

string

optional

N/a. Example: true/false.

seen_card_training

string

optional

N/a. Example: true/false.

seen_card_all

string

optional

N/a. Example: true/false.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/user' \
--data-urlencode 'name=' \
--data-urlencode 'slack_member_id=' \
--data-urlencode 'phone_number=' \
--data-urlencode 'email_alerts=' \
--data-urlencode 'seen_card_anomalies=' \
--data-urlencode 'seen_card_matches=' \
--data-urlencode 'seen_card_training=' \
--data-urlencode 'seen_card_all='

Responses

🟢200An example Response

application/json

Body

status

object (API Response Status)

required

created_timestamp

integer

required

Response created timestamp

created_string

string

required

Response created date/time string

duration

number

required

Duration of response, seconds

language

string

required

Language

timezone

object (Timezone)

required

code

enum<integer>

required

Response code, following HTTP status spec

Allowed values:

200202203204307400401404418500501

oldest_cached_component_age

integer

required

Age in seconds of oldest cached component

session_id

string

required

Session id

org_onboarding_status_id

integer | null

required

Org onboarding status id

api_host

string | null

required

API host

user_onboarding_flags

object (User Onboarding Flags)

optional

org_upgraded

integer | boolean

required

data

object

required

message

enum<string>

required

Allowed value:

user

object (User)

required

Example

{}

Modified at 2024-12-11 16:14:10

/user/update

/user/updatepassword