SHOW MENU

Endpoints » /{account_id}/settings/team/{id}

GET https://api-us.engagor.com/{account_id}/settings/team/{id}

Description

Return a single Team object

GET Parameters

Param Description Required Default Value
This API endpoint doesn't need any parameters.

Result

team The requested Team object.

POST https://api-us.engagor.com/{account_id}/settings/team/{id}

Description

Edit a Team for a certain account.

POST Parameters

Param Description Required Default Value
updates A JSON encoded array of changes you want to make. Structure of the object should be like team, with only those properties you want to update. Yes
options A JSON encoded object of options for the update. Supported keys: "users_edit_mode" (values: `add`, `overwrite`, `delete`, with `overwrite` as default) No

Result

team The updated Team object.

Examples

Add a single user to a team

Remove two users from a team

Replace all users in team with provided ones

DELETE https://api-us.engagor.com/{account_id}/settings/team/{id}

Description

Deletes a Team for a certain account.

Required Access Token Scope

accounts_read, accounts_write

DELETE Parameters

Param Description Required Default Value
This API endpoint doesn't need any parameters.

Result

Boolean that indicates if Team was deleted.