Favorite

A record (Prospect, Account, Sequence, etc.) favorited by a particular user.

createdAt
string <date-time>

The date and time the favorite was created.

targetId
integer

The ID of record that was favorited.

targetType
string <= 255 characters

The type of record that was favorited.

updatedAt
string <date-time>

The date and time the favorite was last updated.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "targetId": 0,
  • "targetType": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Favorite Relationships

(user (data (object) or links (object)))

The user who created the favorite. Relationship creator cannot be used as a filter.

data (object) or links (object) (user)

The user who's favorite this is. You can use only the attribute id to filter favorites by user (e.g. filter[user][id]=X).

{
  • "creator": {
    },
  • "user": {
    }
}

Favorite Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Favorite Actions

Get a Collection of Favorites

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/favorites
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Favorite
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/favorites
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Favorite by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/favorites/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Favorite by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/favorites/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}