GhostLeadOpptyContactRelations.update

Modifies GhostLeadOpptyContactRelation or GhostLeadOpptyContactRelations with given id(s)

Request

Path Params

string <uuid>

required

ID of GhostLeadOpptyContactRelation to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of GhostLeadOpptyContactRelation on update. Use them as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,
16 - allows to set entity on deleted relationship.

Body Params application/json

ghost_contact

object

optional

Relation to GhostContact, see: 'updateGhostContactInput' object for properties.

string <uri>

optional

lead_oppty_contact_group_relation

object

optional

Relation to LeadOpptyContactGroupRelation, see: 'updateLeadOpptyContactGroupRelationInput' object for properties.

string <uri>

optional

comment

string

optional

Multi-line text input field.

Example:

string

ghost_contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

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>

optional

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.

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sales_roles

array [object {1}]

optional

Relations to SalesRoles.

string <uri>

optional

Example

{
  "ghost_contact": {
    "id": "http://example.com"
  },
  "lead_oppty_contact_group_relation": {
    "id": "http://example.com"
  },
  "comment": "string",
  "ghost_contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_oppty_contact_group_relation_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "position_in_group": {},
  "revision": 1,
  "sales_roles": [
    {
      "id": "http://example.com"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting GhostLeadOpptyContactRelation

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (GhostLeadOpptyContactRelation)

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

ghost_contact

string <uri>

required

Relation to GhostContact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'GhostContact' 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

ghost_contact_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

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.

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",
    "ghost_contact": "http://example.com",
    "lead_oppty_contact_group_relation": "http://example.com",
    "lead": "http://example.com",
    "oppty": "http://example.com",
    "comment": "string",
    "ghost_contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_contact_group_relation_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "position_in_group": {},
    "revision": 1,
    "sales_roles": [
      "http://example.com"
    ]
  }
}

🟠404Record Not Found

🔴500Server Error