Either "public" or "confidential". Specifies whether the OAuth client operates in a public environment where credentials cannot be securely stored, or on secure servers that can safely store credentials. See Client types
logo_url
string
true
false
The API logo url of this record
name
string
false
true
The name of this client
redirect_uri
array
false
false
An array of the valid redirect URIs for this client
secret
string
true
false
The client secret. Generated automatically on creation and returned in full only at that time
updated_at
string
true
false
The time of the last update of the client
url
string
true
false
The API url of this record
user_id
integer
false
true
The id of the admin who created the client
Example
{"company":"Zendesk","created_at":"2009-05-13T00:07:08Z","description":"Zendesk Test Client","id":1,"identifier":"test_client","name":"My Test Client","redirect_uri":["https://example.com/callback"],"secret":"af3t24tfj34h43s...","updated_at":"2011-07-22T00:11:12Z","url":"https://example.zendesk.com/api/v2/clients/1.json","user_id":29}
// Status 200 OK{"clients":[{"company":"Zendesk","created_at":"2009-05-13T00:07:08Z","description":"Zendesk Test Client","id":223443,"identifier":"test_client","name":"Stats Widget","redirect_uri":["https://example.com/callback"],"secret":"af3t24tfj34h43s...","updated_at":"2011-07-22T00:11:12Z","url":"https://example.zendesk.com/api/v2/clients/223443.json","user_id":29},{"company":"Zendesk","created_at":"2009-05-13T00:07:08Z","description":"Zendesk Mobile Client","id":8678530,"identifier":"mobile_client","name":"Zendesk Mobile","redirect_uri":["https://example.com/callback"],"secret":"af3t24tfj34h43s...","updated_at":"2011-07-22T00:11:12Z","url":"https://example.zendesk.com/api/v2/clients/8678530.json","user_id":29}]}
// Status 200 OK{"client":{"company":"Zendesk","created_at":"2009-05-13T00:07:08Z","description":"Zendesk Test Client","id":223443,"identifier":"test_client","name":"Test Client","redirect_uri":["https://example.com/callback"],"secret":"af3t24tfj34h43s...","updated_at":"2011-07-22T00:11:12Z","url":"https://example.zendesk.com/api/v2/clients/223443.json","user_id":29}}
// Status 201 Created{"client":{"company":"Zendesk","created_at":"2009-05-13T00:07:08Z","description":"Zendesk Test Client","id":223443,"identifier":"test_client","name":"Test Client","redirect_uri":["https://example.com/callback"],"secret":"af3t24tfj34h43s...","updated_at":"2011-07-22T00:11:12Z","url":"https://example.zendesk.com/api/v2/clients/223443.json","user_id":29}}
Update Client
PUT /api/v2/oauth/clients/{oauth_client_id}
Allowed for
Admins
Parameters
Name
Type
In
Required
Description
oauth_client_id
integer
Path
true
The ID of the OAuth client
Code Samples
curl
curl https://{subdomain}.zendesk.com/api/v2/oauth/clients/{oauth_client_id}.json \ -X PUT -H "Content-Type: application/json"\ -d '{"client": {"name": "My New OAuth2 Client"}}' -v -u {email_address}/token:{api_token}
// Status 200 OK{"client":{"company":"Zendesk","created_at":"2009-05-13T00:07:08Z","description":"Zendesk Test Client","id":223443,"identifier":"test_client","name":"My New OAuth2 Client","redirect_uri":["https://example.com/callback"],"secret":"af3t24tfj34h43s...","updated_at":"2011-07-22T00:11:12Z","url":"https://example.zendesk.com/api/v2/clients/223443.json","user_id":29}}
// Status 200 OK{"client":{"company":"Zendesk","created_at":"2009-05-13T00:07:08Z","description":"Zendesk Test Client","id":223443,"identifier":"test_client","name":"Test Client","redirect_uri":["https://example.com/callback"],"secret":"af3t24tfj34h43s...","updated_at":"2011-07-22T00:11:12Z","url":"https://example.zendesk.com/api/v2/clients/223443.json","user_id":29}}
Privacy Preference Center
Zendesk uses web cookies to collect information about you when you visit our Site. This information might be about you, your preferences, or your device. At Zendesk, we may use this information for purposes that include ensuring basic functionality of our Sites; remembering user preferences, including your cookie preferences; measuring the effectiveness of our Sites, marketing campaigns, and email communications; and personalizing online content.
Please review the different category headings below to learn more and adjust the cookie settings on your current device. Please note that you will need to ensure that each web browser is adjusted to reflect your preferences if you use different computers or mobile devices.
For more information about how Zendesk uses web cookies, please see our Cookie Notice.
Manage Consent Preferences
Essential Cookies
Always Active
Essential cookies enable core site functionality. These cookies are necessary for the Site to function and cannot be switched off in our systems. You may set your browser to block or alert you about these cookies, but parts of the website may not function properly.
Functional Cookies
Functional cookies enable the Site to provide enhanced functionality and personalization. These cookies may be set by us or by third-party providers whose services we have added to our Site.
Analytics Cookies
Analytics cookies allow us to count visits and traffic sources so we can measure and improve the performance of our Site. These cookies help us to know which pages are the most and least popular and see how visitors move around the Site.
Targeting Cookies
Targeting cookies, such as social media cookies, may be set through our Site by our advertising service providers, third-party advertisers, ad networks, or data exchange partners. These cookies may be used to show you relevant advertising on other third-party sites.