Class: BaseCRM::Lead

Inherits:
Model
  • Object
show all
Defined in:
lib/basecrm/models/lead.rb

Instance Attribute Summary collapse

Instance Attribute Details

#addressAddress

Returns:


# File 'lib/basecrm/models/lead.rb', line 78

#created_atDateTime (readonly)

Returns Date and time of the creation in UTC (ISO8601 format).

Returns:

  • (DateTime)

    Date and time of the creation in UTC (ISO8601 format).


# File 'lib/basecrm/models/lead.rb', line 5

#creator_idInteger (readonly)

Returns Unique identifier of the user who created the lead.

Returns:

  • (Integer)

    Unique identifier of the user who created the lead.


# File 'lib/basecrm/models/lead.rb', line 5

#custom_fieldsHash

Returns Custom fields are a either a single key-value pair attached to a lead or a set of key-value pairs attached to a lead. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).

Returns:

  • (Hash)

    Custom fields are a either a single key-value pair attached to a lead or a set of key-value pairs attached to a lead. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).


# File 'lib/basecrm/models/lead.rb', line 78

#descriptionString

Returns Lead description.

Returns:

  • (String)

    Lead description.


# File 'lib/basecrm/models/lead.rb', line 78

#emailString

Returns Lead's email.

Returns:

  • (String)

    Lead's email.


# File 'lib/basecrm/models/lead.rb', line 78

#facebookString

Returns Lead's Facebook nickname.

Returns:

  • (String)

    Lead's Facebook nickname.


# File 'lib/basecrm/models/lead.rb', line 78

#faxString

Returns Lead's fax number.

Returns:

  • (String)

    Lead's fax number.


# File 'lib/basecrm/models/lead.rb', line 78

#first_nameString

Returns First name of the lead.

Returns:

  • (String)

    First name of the lead.


# File 'lib/basecrm/models/lead.rb', line 78

#idInteger (readonly)

Returns Unique identifier of the lead.

Returns:

  • (Integer)

    Unique identifier of the lead.


# File 'lib/basecrm/models/lead.rb', line 5

#industryString

Returns Organization's industry.

Returns:

  • (String)

    Organization's industry.


# File 'lib/basecrm/models/lead.rb', line 78

#last_nameString

Returns Last name of the lead. Required unless `organization_name` field is provided.

Returns:

  • (String)

    Last name of the lead. Required unless `organization_name` field is provided.


# File 'lib/basecrm/models/lead.rb', line 78

#linkedinString

Returns Lead's Linkedin nickname.

Returns:

  • (String)

    Lead's Linkedin nickname.


# File 'lib/basecrm/models/lead.rb', line 78

#mobileString

Returns Lead's mobile phone number.

Returns:

  • (String)

    Lead's mobile phone number.


# File 'lib/basecrm/models/lead.rb', line 78

#organization_nameString

Returns Organization name of the lead. Required unless `last_name` field is provided.

Returns:

  • (String)

    Organization name of the lead. Required unless `last_name` field is provided.


# File 'lib/basecrm/models/lead.rb', line 78

#owner_idInteger

Returns Unique identifier of the user who currently owns the lead.

Returns:

  • (Integer)

    Unique identifier of the user who currently owns the lead.


# File 'lib/basecrm/models/lead.rb', line 78

#phoneString

Returns Lead's phone number.

Returns:

  • (String)

    Lead's phone number.


# File 'lib/basecrm/models/lead.rb', line 78

#skypeString

Returns Lead's Skype nickname.

Returns:

  • (String)

    Lead's Skype nickname.


# File 'lib/basecrm/models/lead.rb', line 78

#statusString

Returns Status of the lead.

Returns:

  • (String)

    Status of the lead.


# File 'lib/basecrm/models/lead.rb', line 78

#tagsArray<String>

Returns An array of tags for a lead. See more at [Tags](/docs/rest/articles/requests#tags).

Returns:

  • (Array<String>)

    An array of tags for a lead. See more at [Tags](/docs/rest/articles/requests#tags).


# File 'lib/basecrm/models/lead.rb', line 78

#titleString

Returns Job title of the lead.

Returns:

  • (String)

    Job title of the lead.


# File 'lib/basecrm/models/lead.rb', line 78

#twitterString

Returns Lead's Twitter handle.

Returns:

  • (String)

    Lead's Twitter handle.


# File 'lib/basecrm/models/lead.rb', line 78

#updated_atDateTime (readonly)

Returns Date and time of the last update in UTC (ISO8601 format).

Returns:

  • (DateTime)

    Date and time of the last update in UTC (ISO8601 format).


# File 'lib/basecrm/models/lead.rb', line 5

#websiteString

Returns Lead's website.

Returns:

  • (String)

    Lead's website.


# File 'lib/basecrm/models/lead.rb', line 78