Skip to content

Change your name or time zone

PATCH
/v1/me
curl --request PATCH \
--url https://example.com/v1/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "time_zone": "example" }'

Who: a signed-in user, not an API key. Not for API keys.

Media typeapplication/json
object
name
string | null
time_zone
string | null

Example generated

{
"name": "example",
"time_zone": "example"
}

OK

Media typeapplication/json
object
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
email
required
string
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
Allowed values: invited unverified active disabled
time_zone
required
string
updated_at
required
string format: date-time

Example

{
"created_by": {
"kind": "user"
},
"status": "invited"
}

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
"error": {
"code": "example",
"fields": {
"additionalProperty": "example"
},
"message": "example"
}
}