LeadOpptyContactRelations.get

Returns LeadOpptyContactRelation with given id

Responses

🟢200OK

application/json

LeadOpptyContactRelation data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (LeadOpptyContactRelation)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

contact

string <uri>

required

Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.

lead_oppty_contact_group_relation

string <uri>

optional

Relation to LeadOpptyContactGroupRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactGroupRelation' object for properties.

lead

string <uri>

optional

Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.

oppty

string <uri>

optional

Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.

comment

string

optional

Multi-line text input field.

Example:

string

contact_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

is_primary

boolean

required

Boolean value.

Example:

false

lead_oppty_contact_group_relation_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_oppty_id

string <uuid>

required

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

position_in_group

object

optional

Field containing json.

relationship

enum<integer>

optional

Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong

Allowed values:

0123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sales_roles

array[string <uri>]

optional

Relations to SalesRoles.

Example

{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "contact": "http://example.com",
    "lead_oppty_contact_group_relation": "http://example.com",
    "lead": "http://example.com",
    "oppty": "http://example.com",
    "comment": "string",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "is_primary": false,
    "lead_oppty_contact_group_relation_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "position_in_group": {},
    "relationship": 0,
    "revision": 1,
    "sales_roles": [
      "http://example.com"
    ]
  }
}

🟠404Record Not Found

🔴500Server Error

LeadOpptyContactRelations.get

Request

Request samples

Responses