OAuth

Update OAuth developer client

patch/api/v1/oauth/clients/{clientId}

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/oauth/clients/{clientId}
  • Auth: HTTP bearer

Path parameters

clientIdstring required

OAuth client_id, such as poc_QxY5kZ9j2f3abCDe

Request body

client_namestring
descriptionstring
homepagestring nullable
allowed_redirect_urisstring[]
default_scopesstring[]
is_activeboolean

Example request

{
  "client_name": "Agency approval app",
  "description": "Internal approval workflow for client posts.",
  "homepage": "https://agency.example.com",
  "allowed_redirect_uris": [
    "https://agency.example.com/oauth/callback"
  ],
  "default_scopes": [
    "accounts:read",
    "posts:read",
    "posts:write"
  ]
}

Response

OAuth client updated successfully

Example response

{
  "client": {
    "id": "7cf9d7b7-f5e4-4e48-9b35-62d2c9421661",
    "client_id": "poc_QxY5kZ9j2f3abCDe",
    "client_name": "Agency approval app",
    "description": "Internal approval workflow for client posts.",
    "homepage": "https://agency.example.com",
    "allowed_redirect_uris": [
      "https://agency.example.com/oauth/callback"
    ],
    "default_scopes": [
      "accounts:read",
      "posts:read",
      "posts:write"
    ],
    "is_active": true,
    "created_at": "2026-05-16T10:00:00.000Z",
    "updated_at": "2026-05-16T10:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.