OnlineFormTypeEmailRelations.get

Returns OnlineFormTypeEmailRelation with given id

Responses

🟢200OK

application/json

OnlineFormTypeEmailRelation data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (OnlineFormTypeEmailRelation)

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

account

string <uri>

optional

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

contact

string <uri>

optional

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.

custom_entity

string <uri>

optional

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

string <uri>

required

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

online_form_type

string <uri>

required

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

quote

string <uri>

optional

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

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

custom_entity_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_id

string <uuid>

required

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

online_form_type_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quote_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

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",
        "account": "http://example.com",
        "contact": "http://example.com",
        "custom_entity": "http://example.com",
        "email": "http://example.com",
        "lead": "http://example.com",
        "oppty": "http://example.com",
        "online_form_type": "http://example.com",
        "quote": "http://example.com",
        "account_id": "01234567-abcd-dcba-ffff-000000000000",
        "contact_id": "01234567-abcd-dcba-ffff-000000000000",
        "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
        "email_id": "01234567-abcd-dcba-ffff-000000000000",
        "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
        "online_form_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "quote_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1
    }
}

🟠404Record Not Found

🔴500Server Error

OnlineFormTypeEmailRelations.get

Request

Request samples

Responses