Opportunity Prospect Role

A prospect's role and association with an opportunity

createdAt
string <date-time>

The date and time the role was created.

primary
boolean

A boolean value indicating if this prospect is the primary contact within an opportunity.

role
string <= 255 characters

A string value representing the role.

updatedAt
string <date-time>

The date and time the role was last updated.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "primary": true,
  • "role": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Opportunity Prospect Role Relationships

data (object) or links (object) (opportunity)

The opportunity associated with the role. You can use only the attribute id to filter opportunityProspectRoles by opportunity (e.g. filter[opportunity][id]=X).

data (object) or links (object) (prospect)

The prospect associated with the role. You can use only the attribute id to filter opportunityProspectRoles by prospect (e.g. filter[prospect][id]=X).

{
  • "opportunity": {
    },
  • "prospect": {
    }
}

Opportunity Prospect Role Resource Metadata

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

⌵ Opportunity Prospect Role Actions

Get a Collection of Opportunity Prospect Roles

SecuritybearerAuth
Responses
200

OK

422

JSON error message

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


422
JSON error message


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


422
JSON error message


delete/opportunityProspectRoles/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get an Opportunity Prospect Role by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/opportunityProspectRoles/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update an Opportunity Prospect Role
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


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