Teams API

Pushover for Teams administrators can make automated changes to team membership through our Teams API.

Note: Calls to this API require a Team API Token for the token parameter, not an Application API Token which is normally used when sending messages.

Response Format

All Teams API calls will respond with a format similar to our other APIs. If your POST or GET request to our API was valid, you will receive an HTTP 200 (OK) status, with a JSON object containing a status code of 1.

{"status":1,"request":"f51d971c-ca76-4646-8c53-f1e72cfb2212"}

If the API call failed for any reason, you will receive an HTTP 400 status with a JSON object containing a status of 0 and an errors array detailing each problem.

{"status":0,
"request":"0b03d2fc-c223-4947-912a-d32244fc6c16",
"errors":[ "team token is invalid" ]}

Any non-200 or non-400 status should be interpreted as an error.

Adding a User to a Team

To add a user to your Team, submit a POST request to:

Include the following parameters:

• token (required) - your team's API token (not an application API token)
• email (required) - the user's e-mail address
• name (optional) - the user's full name
• password (optional) the user's password if assigning one to the user which will not be e-mailed; if not included or left blank, a random password will be assigned to the user and e-mailed to them (in cleartext)
• instant (optional) a string value of true will include an Instant Login link in the initial welcome e-mail to the user; Instant Login links allow the user to optionally download the Pushover app and then login to their new account without entering any credentials, and links are valid for 7 days
• admin (optional) a string value of true will add this user to the team as an administrator
• group (optional) by default, all users are added to your auto-updating Team Delivery Group; to add this user to another Delivery Group, put the group's name in this field (if the group does not exist, it will be created)

Removing a User From a Team

To remove a user from your Team (without deleting the user's Pushover account) and remove them from any team delivery groups, submit a POST request to:

Include the following parameters:

• token (required) - your team's API token (not an application API token)
• email (required) - the user's e-mail address

Note: At least one administrator user must remain on the team at all times.