Install Application

POST https://api.speakap.io/networks/:eid/apps/

Use cases

  • Install an application on your network

Request

URI:/networks/{networkEID}/apps/
Method:POST
Content-Type:application/json
Authentication:OAuth 2.0

Parameters

Name Type Description
networkEID EID Network EID

Request body

Supply a JSON resource consisting of an application EID and a target audience.

Name Type Description
appEID object EID of the application
audience object List of audience objects

Audience properties

Name Type Description
EID EID Unique entity identifier
type string Audience type ('network', 'group' or 'user')

Examples

Note that you should omit installed date as it will be set server-side.

{
    "appEID": "1234567890ABCDEF",
    "audience": [
        {
            "EID": "FEDCBA0987654321",
            "type": "network"
        }
    ]
}

Response

202
Accepted for installation: returns a Feedback object
403
Unauthorized: returns an Error object
404
Unknown application or network: returns an Error object
409
Application already installed: returns an Error object