Freshdesk-Resources-Group.md

Freshdesk\Resources\Group

Group resource

Provides access to the group resources

• Class name: Group
• Namespace: Freshdesk\Resources
• Parent class: Freshdesk\Resources\AbstractResource

Methods

all

mixed Freshdesk\Resources\Group::all(array|null $query)

Get a list of all agents.

Use filters ($query) to view only specific resources (those which match the criteria that you choose).

• Visibility: public

Arguments

• $query array|null

create

array|null Freshdesk\Resources\Group::create(array $data)

Create a resource

Create a resource with the supplied data

• Visibility: public

Arguments

• $data array - <p>The data</p>

view

array|null Freshdesk\Resources\Group::view(integer $id, array|null $query)

View a resource

Use 'include' to embed additional details in the response. Each include will consume an additional credit. For example if you embed the requester and company information you will be charged a total of 3 API credits for the call. See Freshdesk's documentation for details.

• Visibility: public

Arguments

• $id integer - <p>The resource id</p>
• $query array|null

update

array|null Freshdesk\Resources\Group::update(integer $id, array $data)

Update a resource

Updates the resources for the given $id with the supplied data/.

• Visibility: public

Arguments

• $id integer - <p>The resource id</p>
• $data array - <p>The data</p>

delete

array|null Freshdesk\Resources\Group::delete(\Freshdesk\Resources\Traits\in $id)

Delete a resource

Delete a resource by $id

• Visibility: public

Arguments

• $id Freshdesk\Resources\Traits\in - <p>The resource id</p>