Groups

Endpoints to work with groups.

Get groups

GET /api/internal/v1/partners/:partner_id/groups

Get the groups of a partner. The action must be performed by an authenticated user with permission groups.read and partner access.

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.

200

Create group

POST /api/internal/v1/partners/:partner_id/groups

Create a new group. The action must be performed by an authenticated user with permission groups.create and partner access.

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.

200

Get group

GET /api/internal/v1/partners/:partner_id/groups/:group_id

Get a group by its id. The request must be performed by an authenticated user with permission groups.read and partner.access.

Path Parameters

Name	Type	Description
group_id	integer	The id of the group.
partner_id	integer	The id of the partner.

200

Update group

PUT /api/internal/v1/partners/:partner_id/groups/:group_id

Update a group by its id. The action must be performed by an authenticated user with permission groups.update and partner access.

Path Parameters

Name	Type	Description
group_id	integer	The id of the group.
partner_id	integer	The id of the partner.

200

Delete group

DELETE /api/internal/v1/partners/:partner_id/groups/:group_id

Delete a group by its id. The action must be executed by an authenticated user with permission groups.delete and partner access.

Path Parameters

Name	Type	Description
group_id	integer	The id of the group.
partner_id	integer	The id of the partner.

200

Get group customers

GET /api/internal/v1/partners/:partner_id/groups/:group_id/customers

Get the customers of a group. The action must be performed by an authenticated user with permission groups.read and partner access.

Path Parameters

Name	Type	Description
group_id	integer	The id of the group.
partner_id	integer	The id of the partner.

200

Add a customer to a group

POST /api/internal/v1/partners/:partner_id/groups/:group_id/customers

Add a new customer to the group. The action must be performed by an authenticated user with permission groups.update and partner access.

Path Parameters

Name	Type	Description
group_id	integer	The id of the group.
partner_id	integer	The id of the partner.

200

Remove a customer from a group

DELETE /api/internal/v1/partners/:partner_id/groups/:group_id/customers/:customer_id

Path Parameters

Name	Type	Description
customer_id	integer	The id of the customer that is removed.
group_id	integer	The id of the group.
partner_id	integer	The id of the partner.

200