Distribution group and Permission group API

This is the documentation for the Updraft REST API.

Create a new Distribution group

POST https://app.getupdraft.com/api/group-testers/

This endpoint allows you create new Distribution group.

Body data/JSON

Name	Type	Description
app	int	ID of App project
title	string	Name for distribution group

Headers

Name	Type	Description
Authorization	String	Authentication token, note: might require adding "Token" to the value field

Responce

{
    "id": group_id,
    "testers_count": 0,
    "testers": [],
    "title": "group_name",
    "app": project_id
}

Add testers to a Distribution group

POST https://app.getupdraft.com/api/testers/

This endpoint allows you add new testers to a Distribution group.

Body data/JSON

Name	Type	Description
email	string	Email of tester
app	null	Should be set as null
groups	list of int	List of group IDs

Headers

Name	Type	Description
Authorization	string	Authentication token, note: might require adding "Token" to the value field

Responce

{
    "id": tester_id,
    "email": "tester email",
    "app": null,
    "groups": [
        group_id
    ]
}

Create a new Permission group

POST https://app.getupdraft.com/api/groupsinorgs/

This endpoint allows you create new Permission group.

Body data/JSON

Name	Type	Description
title	string	Title of new Permission group
organization	int	ID of organisation

Headers

Name	Type	Description
Authorization	string	Authentication token, note: might require adding "Token" to the value field

Responce

{
    "id": group_id,
    "title": "group_title",
    "organization": organisation_id,
    "members": 0,
    "projects": []
}

Add user to a Permission group

POST https://app.getupdraft.com/api/useringrouporg/

This endpoint allows you add new users to a Permission group.

Body data/JSON

Name	Type	Description
user	int	User ID
groups	list of int	List of group IDs

Headers

Authorization	string	Authentication token, note: might require adding "Token" to the value field