Update an application - Applications - API Reference

PATCH

/v3/applications

Updates a Nylas application using the client ID associated with the specified API key.

⚠️ This endpoint will be removed in the future when application settings are available in the Nylas Dashboard.

When you make a PATCH request, Nylas replaces all data in the nested object with the information included in your request. For more information, see Updating objects.

NYLAS API KEY

Request body

application_idstring

Application ID

Example: "ad410018-d306-43f9-8361-fa5d7b2172e0"

organization_idstring

ID of organization

Example: "f5db4482-dbbe-4b32-b347-61c260d803ce"

regionstring

Region identifier

Example: "us"

environmentstring

Environment identifier

productionstaging

v2_application_idstring

Linked v2 Application ID

Example: "9nsr7pjw1e1g6hgy9l1znjql7"

brandingobject

hosted_authenticationobject

callback_urisarray<object>

A list of your application's callback URIs.

Responses

successboolean

Example: true

dataobject

curl --request PATCH \ --url 'https://api.us.nylas.com/v3/applications' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --data '{ "branding": { "name": "<APPLICATION_NAME>", "icon_url": "<ICON_URL>", "website_url": "<WEBSITE_URL>", "description": "<APPLICATION_DESCRIPTION>" }, "hosted_authentication": { "background_image_url": "<BACKGROUND_IMAGE_URL>", "alignment": "<ALIGNMENT>", "color_primary": "<COLOR_PRIMARY>", "color_secondary": "<COLOR_SECONDARY>", "title": "<TITLE>", "subtitle": "<SUBTITLE>", "background_color": "<BACKGROUND_COLOR>", "spacing": 10 }, "callback_uris": [ { "id": "<CALLBACK_URI_ID>", "url": "<CALLBACK_URL>", "platform": "<PLATFORM>", "settings": { "origin": "<ORIGIN>", "bundle_id": "<BUNDLE_ID>", "package_name": "<PACKAGE_NAME>", "sha1_certificate_fingerprint": "<SHA1_FINGERPRINT>" } } ] }'