v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Authorizations

Update an authorization

Update an existing authorization.

patch/authorizations/{id}

Path parameters

idstring required

ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

notestring

A note to help you remember what the access is used for.

scopesstring[]

A list of scopes that the access can be used for.

expires_atstring date-time

Expiration date for the authorization token. Null means no expiration date (default).

Example request

{
  "note": "My Deploy Script",
  "scopes": [
    "read",
    "write"
  ],
  "expires_at": "2015-03-30T09:52:53Z"
}

Response

OK

idstring
notestring
token_last_eightstring
hashed_tokenstring
scopesstring[]
expires_atstring date-time
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "note": "My Deploy Script",
  "token_last_eight": "1234abcd",
  "hashed_token": "abcd1234cdef1234abcd1234cdef1234abcd1234cdef1234abcd1234cdef1234",
  "scopes": [
    "read"
  ],
  "expires_at": "2015-03-30T09:52:53Z",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}