Skip to end of banner
Go to start of banner

contact_consent_short

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

 contact consent object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

contact_consent_state

String

The state of the Contact's Consent. Applicable values are:

  • PENDING
  • ACCEPTED
  • REJECTED
  • WITHDRAWN
contact_consent_updated_dateDateThe updated date of the Contact's Consent
contact_consent_formAttachments Object

The Contact's accepted Consent Form. Applicable only if Consent State is ACCEPTED

Referred Objects Response Data

 attachments_complete

Name

Type

Description

id

String

The ID of the retrieved attachment

entityString

The name of the entity related with the attachment. The supported entities are the following:

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • COMMUNICATIONS
  • COMMUNICATIONTEMPLATES
  • CONTACTINFORMATION
  • INSTALLEDITEMS
  • JOBS
  • LEADS
  • PRODUCTS
  • SERVICEREQUESTS
  • ATTACHMENTSLIBRARY

From CRM.COM R12.2.0, ATTACHMENTSLIBRARY is available

From CRM.COM R14.0.0, COMMUNICATIONTEMPLATES is available

entity_idStringThe ID of the entity related with the attachment.
urlStringThe attached URL. This information is empty if the attachment is a file.
notesStringThe comments related with the retrieved attachment
classificationAttachments Classification Object

The classification of the attachment

Available from CRM.COM R12.2.0

fileFile ObjectThe information of the attached file. This information is empty if the attachment is a URL.
log_informationLog Information ObjectThe log information of the retrieved attachment

Referred Objects Response Data

 classification object response data

 

NameTypeDescription

id

String

The id of the retrieved attachment classification

name

String

The name of the retrieved attachment classification

alternative_code

String

The alternative code of the retrieved attachment classification

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

  • No labels