Skip to content

Latest commit

 

History

History
142 lines (67 loc) · 2.75 KB

Freshdesk-Resources-Contact.md

File metadata and controls

142 lines (67 loc) · 2.75 KB
Raw

Freshdesk\Resources\Contact

Contact resource

Provides access to the contact resources

Methods

fields

array|null Freshdesk\Resources\Contact::fields(array|null $query)

List contact fields

The agent whose credentials (API key or username/password) are being used to make this API call should be authorised to view the contact fields

  • Visibility: public

Arguments

  • $query array|null

makeAgent

array|null Freshdesk\Resources\Contact::makeAgent(integer $id, array|null $query)

Convert a contact into an agent

Note:

  1. The contact must have an email address in order to be converted into an agent.
  2. If your account has already reached the maximum number of agents, the API request will fail with HTTP error code 403
  3. The agent whose credentials (API key, username and password) were used to make this API call should be authorised to convert a contact into an agent
  • Visibility: public

Arguments

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

all

mixed Freshdesk\Resources\Contact::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\Contact::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\Contact::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\Contact::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\Contact::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>