Update the application

PATCH

/v1/application

curl --request PATCH \
  --url https://api.inboxcnx.com/v1/application \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "subscribedRoles": [ "inbox", "sent" ], "returnUrls": [ "https://app.example.com/inbox/connected" ] }'

Changes the caller application’s folder filter, the return URLs of the connect flow, or pauses processing for all its grants. A changed folder filter applies to new mail only and backfills nothing. While paused, mail that arrives is skipped, not queued.

Requires the write:application scope.

Authorizations

• apiKey

Request Body

Media typeapplication/json

object

subscribedRoles

Array<string>

>= 1 items

Allowed values: inbox sent archive drafts junk trash

paused

boolean

returnUrls

Replaces the URLs POST /v1/connections/initiate accepts as returnUrl. Each must use https (http only on localhost) and carry no query or fragment; at most 10.

Array<string>

<= 10 items

Example

{
  "subscribedRoles": [
    "inbox",
    "sent"
  ],
  "returnUrls": [
    "https://app.example.com/inbox/connected"
  ]
}

Responses

200

The updated application

Media typeapplication/json

object

id

required

string

name

required

string

mode

required

string

Allowed values: direct whitelabel

defaultRetentionDays

required

number

subscribedRoles

required

Array<string>

returnUrls

required

Array<string>

createdAt

required

string

updatedAt

required

string

terminatedAt

required

string | null

paused

required

boolean

blocked

required

boolean

Example

{
  "mode": "direct"
}

400

Invalid body

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

The credential lacks the write:application scope

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

The caller’s application no longer exists

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

The application is terminated

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}