Sign in
Applications

Update an application

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

<div id="admonition-warning">⚠️ <b>This endpoint will be removed in the future when application settings are available in the Nylas Dashboard</b>.</div>

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.

patch/v3/applications

Request body

application_idstring

Application ID

organization_idstring

ID of organization

regionstring

Region identifier

environment'production' | 'staging'

Environment identifier

default_workspace_idstring

The ID of the application's default workspace, if one exists. Nylas manages this value, and ignores it in create and update requests.

v2_application_idstring

Linked v2 Application ID

Example request

{
  "application_id": "ad410018-d306-43f9-8361-fa5d7b2172e0",
  "organization_id": "f5db4482-dbbe-4b32-b347-61c260d803ce",
  "region": "us",
  "default_workspace_id": "abf6ff99-05ad-4c0a-aaf8-400aacf2470a",
  "v2_application_id": "9nsr7pjw1e1g6hgy9l1znjql7",
  "branding": {
    "name": "My application",
    "icon_url": "https://my-app.com/my-icon.png",
    "website_url": "https://my-app.com",
    "description": "Online banking application."
  },
  "hosted_authentication": {
    "background_image_url": "https://my-app.com/bg.jpg",
    "color_primary": "#dc0000",
    "color_secondary": "#000056",
    "background_color": "#003400",
    "spacing": 5
  },
  "callback_uris": [
    {
      "id": "0556d035-6cb6-4262-a035-6b77e11cf8fc",
      "url": "https://yourapp.com/callback"
    }
  ]
}

Response

Returns application object

successboolean

Example response

{
  "success": true,
  "data": {
    "application_id": "ad410018-d306-43f9-8361-fa5d7b2172e0",
    "organization_id": "f5db4482-dbbe-4b32-b347-61c260d803ce",
    "region": "us",
    "default_workspace_id": "abf6ff99-05ad-4c0a-aaf8-400aacf2470a",
    "v2_application_id": "9nsr7pjw1e1g6hgy9l1znjql7",
    "branding": {
      "name": "My application",
      "icon_url": "https://my-app.com/my-icon.png",
      "website_url": "https://my-app.com",
      "description": "Online banking application."
    },
    "hosted_authentication": {
      "background_image_url": "https://my-app.com/bg.jpg",
      "color_primary": "#dc0000",
      "color_secondary": "#000056",
      "background_color": "#003400",
      "spacing": 5
    },
    "callback_uris": [
      {
        "id": "0556d035-6cb6-4262-a035-6b77e11cf8fc",
        "url": "https://yourapp.com/callback"
      }
    ]
  }
}

Changes