Edit

Update the name, description, IP lock and/or active status of an application

Tokens

This action requires the following tokens:

  • application-write

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
application Hash   The ID of the application to edit
name String   The new name of the application
description String   The new description of the application
iplock IP Mask  

The new IP lock for this application

This argument can be unset by providing an empty string

isactive Boolean   The new active status of this application
timezone TimeZone   The new default timezone for this application

Output

This action produces the following output on success:

An object containing the following fields:

Name Type Description
id Hash Application ID
name String Application name
description String Application description
iplock IP Mask IP-lock data for this application
datecreated DateTime When the application was created
datemodified DateTime When the application was last modified
active Boolean Whether this application is active
account Hash Account for this application
customer Hash Customer for this application
timezone TimeZone Timezone for this application

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_APPLICATION_NOT_FOUND (260)
If the application specified by “application” can not be found