Contacts

Contacts

Creates a new contact record that does not already exist.

This method will auto-generate an ID and create a new contact. If an ID is specified for the contact, an error will be thrown.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The contact that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this contact

number
number <float> (Number)

The contact number

date_profile_last_updated
string <date-time> (Date Profile Last Updated)

The date that this contact profile was last updated

name
string (Name)

The full name of the contact

full_name
string (Full Name)

Full name

name_last_first
string (Name Last First)

The full name of the contact, last first

organization_id
string (Organization)

The ID of the organization that the contact belongs to

organization_name
string (Organization Name)

The name of the organization; if an organization ID is present, this information is automatically populated

new_organization_info
object (New Organization Info)
contact_role_ids
Array of strings (Contact Roles)

The ids of the contact roles this contact plays in the linked organization.

contact_roles
string (Contact Roles)

READ ONLY - the name of contact roles

job_title
string (Job Title)

The contact's professional title

prefix
string (Prefix)

The contact prefix

salutation
string (Salutation)

The contact salutation

first_name
string (First Name)

The first name

middle_name
string (Middle Name)

The middle name/initial

last_name
string (Last Name)

The last name

maiden_name
string (Maiden Name)

The maiden name

nickname
string (Nickname)

The nickname of the contact

link_work_address_to_organization
boolean (Link Work Address To Organization)

When set, a change in the organization's address changes the contact work address

link_work_phone_number_to_organization
boolean (Link Work Phone Number To Organization)

When set, a change in the organization's phone changes the contact work phone

suffix
string (Suffix)

The contact suffix (Jr., Sr., etc0

credentials
string (Credentials)

Professional credentials/designation (MBA, Esq, PhD, etc)

email_address
string (Email Address)

The primary email address

email_address2
string (Email Address2)

Secondary email address

email_address3
string (Email Address3)

Tertiary email address

mobile_phone_number
string (Mobile Phone Number)

Mobile phone number

work_mobile_phone_number
string (Work Mobile Phone Number)

Mobile phone number for business unit

spouse_id
string (Spouse)

The ID of this person's spouse

home_phone_number
string (Home Phone Number)

Home phone number

work_phone_number
string (Work Phone Number)

Work phone number

fax_phone_number
string (Fax Phone Number)

Fax phone number

school_phone_number
string (School Phone Number)

Fax phone number

preferred_phone_number
string (Preferred Phone Number)

The preferred phone number, calculated based on the preferred phone number type

preferred_phone_number_type
string (Preferred Phone Number Type)

The phone number at which the contact prefers to be reach

Enum: "mobile" "home" "work" "work mobile" "alternate" "school" "fax"
preferred_phone_number_type_id
required
string (Preferred Alternate Phone Number Type)

When a alternate phone number type is preferred, the ID

Array of objects
object (Address)

A complete address

object (Address)

A complete address

object (Address)

A complete address

object (Address)

A complete address

seasonal_address_start
string <date-time> (Seasonal Address Start)

The start date for the seasonal address

seasonal_address_end
string <date-time> (Seasonal Address End)

The end date for the seasonal address

Array of objects
object (Address)

A complete address

preferred_address_type
string (Preferred Address Type)

The address at which the contact prefers to be contacted

Enum: "home" "work" "school" "alternate"
preferred_address_type_id
required
string (Preferred Alternate Address Type)

When a alternate phone number type is preferred, the ID

image_url
string (Image Url)

A url of the image/photo of this contact

gender
string (Gender)

The gender of the contact

Enum: "male" "female"
pronouns
string (Pronouns)
date_of_birth
string <date> (Date Of Birth)

The date of birth of the contact, expressed in ISO-8601 date format

date_of_death
string <date-time> (Date Of Death)

The date this contact passed away

date_social_profile_last_updated
string <date> (Social Profile Last Updated)

The date that the social profile was last updated

notes
string (Notes)

Any contact notes

status
string (Status)

The status of the contact record

Enum: "active" "duplicate" "deceased" "inactive"
Array of objects

A list of previous organization affiliations

facebook
string (Facebook)

Url to the contact's Facebook account

twitter
string (Twitter)

Url to the contact's Twitter account

instagram
string (Instagram)

Url to the contact's Instagram account

linked_in
string (LinkedIn)

Url to the contact's LinkedIn account

user_ids
Array of strings (Users)

A list of related portal user IDs

merged_ids
Array of strings (Mergeds)

A list contact IDs that have been merged into this contact

Array of objects (Custom Field Values)
origin_service
string (Origin Service)

If this contact was created by another service, the service is here

origin_service_record_id
string (Origin Service Record)

If this contact was created by another service, the relevant iD

do_not_mail
boolean (Do Not Mail)

If set, no mail goes to the contact

do_not_call
boolean (Do Not Call)

If so, the person is not to be called

email_opt_out
boolean (Email Opt Out)

This contact has opted out of ALL email communications

Array of objects

The communication types to which this person is subscribed

communication_preferences_last_confirmed
string <date-time> (Communication Preferences Last Confirmed)

The date that the communication preferences were last confirmed for this contact

Array of objects non-empty

Allows for this contact to be managed by other contacts in the portal

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The contact was saved successfully.
400The contact you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The contact could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add contact based on tenant limits.
500General server error.
post/contacts/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [
    ],
  • "home_address": {
    },
  • "work_address": {
    },
  • "school_address": {
    },
  • "seasonal_address": {
    },
  • "seasonal_address_start": "2019-08-24T14:15:22Z",
  • "seasonal_address_end": "2019-08-24T14:15:22Z",
  • "other_addresses": [
    ],
  • "preferred_address": {
    },
  • "preferred_address_type": "home",
  • "preferred_address_type_id": "string",
  • "image_url": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "date_of_birth": "2019-08-24",
  • "date_of_death": "2019-08-24T14:15:22Z",
  • "date_social_profile_last_updated": "2019-08-24",
  • "notes": "string",
  • "status": "active",
  • "organization_history": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "instagram": "string",
  • "linked_in": "string",
  • "user_ids": [
    ],
  • "merged_ids": [
    ],
  • "custom_field_values": [
    ],
  • "origin_service": "string",
  • "origin_service_record_id": "string",
  • "do_not_mail": true,
  • "do_not_call": true,
  • "email_opt_out": true,
  • "communication_preferences": [
    ],
  • "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  • "portal_delegates": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [
    ],
  • "home_address": {
    },
  • "work_address": {
    },
  • "school_address": {
    },
  • "seasonal_address": {
    },
  • "seasonal_address_start": "2019-08-24T14:15:22Z",
  • "seasonal_address_end": "2019-08-24T14:15:22Z",
  • "other_addresses": [
    ],
  • "preferred_address": {
    },
  • "preferred_address_type": "home",
  • "preferred_address_type_id": "string",
  • "image_url": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "date_of_birth": "2019-08-24",
  • "date_of_death": "2019-08-24T14:15:22Z",
  • "date_social_profile_last_updated": "2019-08-24",
  • "notes": "string",
  • "status": "active",
  • "organization_history": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "instagram": "string",
  • "linked_in": "string",
  • "user_ids": [
    ],
  • "merged_ids": [
    ],
  • "custom_field_values": [
    ],
  • "origin_service": "string",
  • "origin_service_record_id": "string",
  • "do_not_mail": true,
  • "do_not_call": true,
  • "email_opt_out": true,
  • "communication_preferences": [
    ],
  • "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  • "portal_delegates": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a contact from the system by its ID.

This method will look up a contact by the specified ID and return it back.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the contact to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The contact was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The contact could not be found.
429Limit exceeded... unable to retrieve contact based on tenant limits.
500General server error.
get/contacts/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/contacts/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [
    ],
  • "home_address": {
    },
  • "work_address": {
    },
  • "school_address": {
    },
  • "seasonal_address": {
    },
  • "seasonal_address_start": "2019-08-24T14:15:22Z",
  • "seasonal_address_end": "2019-08-24T14:15:22Z",
  • "other_addresses": [
    ],
  • "preferred_address": {
    },
  • "preferred_address_type": "home",
  • "preferred_address_type_id": "string",
  • "image_url": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "date_of_birth": "2019-08-24",
  • "date_of_death": "2019-08-24T14:15:22Z",
  • "date_social_profile_last_updated": "2019-08-24",
  • "notes": "string",
  • "status": "active",
  • "organization_history": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "instagram": "string",
  • "linked_in": "string",
  • "user_ids": [
    ],
  • "merged_ids": [
    ],
  • "custom_field_values": [
    ],
  • "origin_service": "string",
  • "origin_service_record_id": "string",
  • "do_not_mail": true,
  • "do_not_call": true,
  • "email_opt_out": true,
  • "communication_preferences": [
    ],
  • "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  • "portal_delegates": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a contact with the specified ID.

This method will update an existing contact with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the contact to update.

Request Body schema: application/json

The updated contact that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this contact

number
number <float> (Number)

The contact number

date_profile_last_updated
string <date-time> (Date Profile Last Updated)

The date that this contact profile was last updated

name
string (Name)

The full name of the contact

full_name
string (Full Name)

Full name

name_last_first
string (Name Last First)

The full name of the contact, last first

organization_id
string (Organization)

The ID of the organization that the contact belongs to

organization_name
string (Organization Name)

The name of the organization; if an organization ID is present, this information is automatically populated

new_organization_info
object (New Organization Info)
contact_role_ids
Array of strings (Contact Roles)

The ids of the contact roles this contact plays in the linked organization.

contact_roles
string (Contact Roles)

READ ONLY - the name of contact roles

job_title
string (Job Title)

The contact's professional title

prefix
string (Prefix)

The contact prefix

salutation
string (Salutation)

The contact salutation

first_name
string (First Name)

The first name

middle_name
string (Middle Name)

The middle name/initial

last_name
string (Last Name)

The last name

maiden_name
string (Maiden Name)

The maiden name

nickname
string (Nickname)

The nickname of the contact

link_work_address_to_organization
boolean (Link Work Address To Organization)

When set, a change in the organization's address changes the contact work address

link_work_phone_number_to_organization
boolean (Link Work Phone Number To Organization)

When set, a change in the organization's phone changes the contact work phone

suffix
string (Suffix)

The contact suffix (Jr., Sr., etc0

credentials
string (Credentials)

Professional credentials/designation (MBA, Esq, PhD, etc)

email_address
string (Email Address)

The primary email address

email_address2
string (Email Address2)

Secondary email address

email_address3
string (Email Address3)

Tertiary email address

mobile_phone_number
string (Mobile Phone Number)

Mobile phone number

work_mobile_phone_number
string (Work Mobile Phone Number)

Mobile phone number for business unit

spouse_id
string (Spouse)

The ID of this person's spouse

home_phone_number
string (Home Phone Number)

Home phone number

work_phone_number
string (Work Phone Number)

Work phone number

fax_phone_number
string (Fax Phone Number)

Fax phone number

school_phone_number
string (School Phone Number)

Fax phone number

preferred_phone_number
string (Preferred Phone Number)

The preferred phone number, calculated based on the preferred phone number type

preferred_phone_number_type
string (Preferred Phone Number Type)

The phone number at which the contact prefers to be reach

Enum: "mobile" "home" "work" "work mobile" "alternate" "school" "fax"
preferred_phone_number_type_id
required
string (Preferred Alternate Phone Number Type)

When a alternate phone number type is preferred, the ID

Array of objects
object (Address)

A complete address

object (Address)

A complete address

object (Address)

A complete address

object (Address)

A complete address

seasonal_address_start
string <date-time> (Seasonal Address Start)

The start date for the seasonal address

seasonal_address_end
string <date-time> (Seasonal Address End)

The end date for the seasonal address

Array of objects
object (Address)

A complete address

preferred_address_type
string (Preferred Address Type)

The address at which the contact prefers to be contacted

Enum: "home" "work" "school" "alternate"
preferred_address_type_id
required
string (Preferred Alternate Address Type)

When a alternate phone number type is preferred, the ID

image_url
string (Image Url)

A url of the image/photo of this contact

gender
string (Gender)

The gender of the contact

Enum: "male" "female"
pronouns
string (Pronouns)
date_of_birth
string <date> (Date Of Birth)

The date of birth of the contact, expressed in ISO-8601 date format

date_of_death
string <date-time> (Date Of Death)

The date this contact passed away

date_social_profile_last_updated
string <date> (Social Profile Last Updated)

The date that the social profile was last updated

notes
string (Notes)

Any contact notes

status
string (Status)

The status of the contact record

Enum: "active" "duplicate" "deceased" "inactive"
Array of objects

A list of previous organization affiliations

facebook
string (Facebook)

Url to the contact's Facebook account

twitter
string (Twitter)

Url to the contact's Twitter account

instagram
string (Instagram)

Url to the contact's Instagram account

linked_in
string (LinkedIn)

Url to the contact's LinkedIn account

user_ids
Array of strings (Users)

A list of related portal user IDs

merged_ids
Array of strings (Mergeds)

A list contact IDs that have been merged into this contact

Array of objects (Custom Field Values)
origin_service
string (Origin Service)

If this contact was created by another service, the service is here

origin_service_record_id
string (Origin Service Record)

If this contact was created by another service, the relevant iD

do_not_mail
boolean (Do Not Mail)

If set, no mail goes to the contact

do_not_call
boolean (Do Not Call)

If so, the person is not to be called

email_opt_out
boolean (Email Opt Out)

This contact has opted out of ALL email communications

Array of objects

The communication types to which this person is subscribed

communication_preferences_last_confirmed
string <date-time> (Communication Preferences Last Confirmed)

The date that the communication preferences were last confirmed for this contact

Array of objects non-empty

Allows for this contact to be managed by other contacts in the portal

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The contact was updated successfully.
400The contact supplied was not valid.
401Unauthorized.
403Forbidden.
404The contact could not be found.
409The contact could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve contact based on tenant limits.
500General server error.
put/contacts/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [
    ],
  • "home_address": {
    },
  • "work_address": {
    },
  • "school_address": {
    },
  • "seasonal_address": {
    },
  • "seasonal_address_start": "2019-08-24T14:15:22Z",
  • "seasonal_address_end": "2019-08-24T14:15:22Z",
  • "other_addresses": [
    ],
  • "preferred_address": {
    },
  • "preferred_address_type": "home",
  • "preferred_address_type_id": "string",
  • "image_url": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "date_of_birth": "2019-08-24",
  • "date_of_death": "2019-08-24T14:15:22Z",
  • "date_social_profile_last_updated": "2019-08-24",
  • "notes": "string",
  • "status": "active",
  • "organization_history": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "instagram": "string",
  • "linked_in": "string",
  • "user_ids": [
    ],
  • "merged_ids": [
    ],
  • "custom_field_values": [
    ],
  • "origin_service": "string",
  • "origin_service_record_id": "string",
  • "do_not_mail": true,
  • "do_not_call": true,
  • "email_opt_out": true,
  • "communication_preferences": [
    ],
  • "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  • "portal_delegates": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [
    ],
  • "home_address": {
    },
  • "work_address": {
    },
  • "school_address": {
    },
  • "seasonal_address": {
    },
  • "seasonal_address_start": "2019-08-24T14:15:22Z",
  • "seasonal_address_end": "2019-08-24T14:15:22Z",
  • "other_addresses": [
    ],
  • "preferred_address": {
    },
  • "preferred_address_type": "home",
  • "preferred_address_type_id": "string",
  • "image_url": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "date_of_birth": "2019-08-24",
  • "date_of_death": "2019-08-24T14:15:22Z",
  • "date_social_profile_last_updated": "2019-08-24",
  • "notes": "string",
  • "status": "active",
  • "organization_history": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "instagram": "string",
  • "linked_in": "string",
  • "user_ids": [
    ],
  • "merged_ids": [
    ],
  • "custom_field_values": [
    ],
  • "origin_service": "string",
  • "origin_service_record_id": "string",
  • "do_not_mail": true,
  • "do_not_call": true,
  • "email_opt_out": true,
  • "communication_preferences": [
    ],
  • "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  • "portal_delegates": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a contact with the specified ID.

This method will patch an existing contact with the specified ID, using the HTTP PATCH specification.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the contact to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The contact was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The contact could not be found.
409The contact could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve contact based on tenant limits.
500General server error.
patch/contacts/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [
    ],
  • "home_address": {
    },
  • "work_address": {
    },
  • "school_address": {
    },
  • "seasonal_address": {
    },
  • "seasonal_address_start": "2019-08-24T14:15:22Z",
  • "seasonal_address_end": "2019-08-24T14:15:22Z",
  • "other_addresses": [
    ],
  • "preferred_address": {
    },
  • "preferred_address_type": "home",
  • "preferred_address_type_id": "string",
  • "image_url": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "date_of_birth": "2019-08-24",
  • "date_of_death": "2019-08-24T14:15:22Z",
  • "date_social_profile_last_updated": "2019-08-24",
  • "notes": "string",
  • "status": "active",
  • "organization_history": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "instagram": "string",
  • "linked_in": "string",
  • "user_ids": [
    ],
  • "merged_ids": [
    ],
  • "custom_field_values": [
    ],
  • "origin_service": "string",
  • "origin_service_record_id": "string",
  • "do_not_mail": true,
  • "do_not_call": true,
  • "email_opt_out": true,
  • "communication_preferences": [
    ],
  • "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  • "portal_delegates": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a contact from the system by its ID.

This method will delete a contact with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the contact to delete.

Responses
200The contact was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The contact could not be found.
409The contact could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete contact based on tenant limits.
500General server error.
delete/contacts/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://rolodex.api.756794052567.rhythmsoftware.com/contacts/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Searches for contacts using predefined parameters

Searches for contacts using predefined parameters

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
exclusiveStartKey
string

The start key for the search, for paging support

fieldsToReturn
string

The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The contact that you would like to be saved.

ids
Array of strings (Ids)

IDs to search

status
Array of strings (Status)
first_name
string (First Name)
last_name
string (Last Name)
contact_role_id
string (Contact Role)
email_address
string (Email Address)
organization_name
string (Organization Name)
nickname
string (Nickname)
number
Array of numbers <float> (Number)
organization_id
Array of strings (Organization)
job_title
string (Job Title)
city
string (City)

City to search

state
string (State)

The state

country
string (Country)

The country

Responses
200The contact search was saved successfully.
400The contact you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The contact could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add contact based on tenant limits.
500General server error.
post/contacts/{tenantId}/search
Request samples
application/json
{
  • "ids": [
    ],
  • "status": [
    ],
  • "first_name": "string",
  • "last_name": "string",
  • "contact_role_id": "string",
  • "email_address": "string",
  • "organization_name": "string",
  • "nickname": "string",
  • "number": [
    ],
  • "organization_id": [
    ],
  • "job_title": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Updates a contact with data merged from other contacts then signals other microservices to complete the merge

Updates a contact with data merged from other contacts then signals other microservices to complete the merge

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the contact to merge.

Request Body schema: application/json

The updated contact to be merged.

source_ids
required
Array of strings (Sources) non-empty

The source IDs to merge

object (Options)
Responses
200The contact was merged successfully.
400The contact supplied was not valid.
401Unauthorized
403Forbidden
404The contact could not be found.
409The contact could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to merge contact based on tenant limits.
500General server error.
put/contacts/{tenantId}/{id}/merge
Request samples
application/json
{
  • "source_ids": [
    ],
  • "options": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [
    ],
  • "home_address": {
    },
  • "work_address": {
    },
  • "school_address": {
    },
  • "seasonal_address": {
    },
  • "seasonal_address_start": "2019-08-24T14:15:22Z",
  • "seasonal_address_end": "2019-08-24T14:15:22Z",
  • "other_addresses": [
    ],
  • "preferred_address": {
    },
  • "preferred_address_type": "home",
  • "preferred_address_type_id": "string",
  • "image_url": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "date_of_birth": "2019-08-24",
  • "date_of_death": "2019-08-24T14:15:22Z",
  • "date_social_profile_last_updated": "2019-08-24",
  • "notes": "string",
  • "status": "active",
  • "organization_history": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "instagram": "string",
  • "linked_in": "string",
  • "user_ids": [
    ],
  • "merged_ids": [
    ],
  • "custom_field_values": [
    ],
  • "origin_service": "string",
  • "origin_service_record_id": "string",
  • "do_not_mail": true,
  • "do_not_call": true,
  • "email_opt_out": true,
  • "communication_preferences": [
    ],
  • "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  • "portal_delegates": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Looks up a social profile and returns what is found to the user

This method will make a call and parse/return the results

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

emailAddress
required
string

The email address to look up

Responses
200The social profile was retrieved successfully
400The request was not valid
401Unauthorized
403Forbidden
404The social profile was not found
429Limit exceeded... unable to retrieve counts based on tenant limits.
500General server error
get/contacts/{tenantId}/socialProfile/{emailAddress}
Request samples
curl -i -X GET \
  https://rolodex.api.756794052567.rhythmsoftware.com/contacts/:tenantId/socialProfile/:emailAddress \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "fullName": "string",
  • "emailAddress": "string",
  • "gender": "male",
  • "avatar": "string",
  • "organization": "string",
  • "title": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "linkedin": "string",
  • "bio": "string",
  • "details": { }
}

Get contacts (and descendants recursively) for an organization

Does a recursive lookup of contacts by organization

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

organization_id
required
string

The organization

query Parameters
fieldsToReturn
string

The organization

Responses
200The social profile was retrieved successfully
400The request was not valid
401Unauthorized
403Forbidden
404The social profile was not found
429Limit exceeded... unable to retrieve counts based on tenant limits.
500General server error
get/contacts/{tenantId}/descendants/{organization_id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/contacts/:tenantId/descendants/:organization_id?fieldsToReturn=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Checks whether a contact can manage another

Checks to see if a contact is clear to manage another contact by email addess

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

managerId
required
string

The id of the manager

query Parameters
emailAddress
required
string

The email address to look up

Responses
200The social profile was retrieved successfully
400The request was not valid
401Unauthorized
403Forbidden
404The social profile was not found
429Limit exceeded... unable to retrieve counts based on tenant limits.
500General server error
get/contacts/{tenantId}/checkManageability/{managerId}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/contacts/:tenantId/checkManageability/:managerId?emailAddress=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "fullName": "string",
  • "emailAddress": "string",
  • "gender": "male",
  • "avatar": "string",
  • "organization": "string",
  • "title": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "linkedin": "string",
  • "bio": "string",
  • "details": { }
}

Returns the contact related to the currently logged in user

Returns the contact related to the currently logged in user

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

idToken
required
string

The ID token

Responses
200The contact was retrieved successfully.
400The request was not valid.
401Unauthorized
403Forbidden
404The contact could not be found.
429Limit exceeded... unable to retrieve contact based on tenant limits.
500General server error.
get/contacts/{tenantId}/current
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/contacts/:tenantId/current?fields=string&idToken=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [
    ],
  • "home_address": {
    },
  • "work_address": {
    },
  • "school_address": {
    },
  • "seasonal_address": {
    },
  • "seasonal_address_start": "2019-08-24T14:15:22Z",
  • "seasonal_address_end": "2019-08-24T14:15:22Z",
  • "other_addresses": [
    ],
  • "preferred_address": {
    },
  • "preferred_address_type": "home",
  • "preferred_address_type_id": "string",
  • "image_url": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "date_of_birth": "2019-08-24",
  • "date_of_death": "2019-08-24T14:15:22Z",
  • "date_social_profile_last_updated": "2019-08-24",
  • "notes": "string",
  • "status": "active",
  • "organization_history": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "instagram": "string",
  • "linked_in": "string",
  • "user_ids": [
    ],
  • "merged_ids": [
    ],
  • "custom_field_values": [
    ],
  • "origin_service": "string",
  • "origin_service_record_id": "string",
  • "do_not_mail": true,
  • "do_not_call": true,
  • "email_opt_out": true,
  • "communication_preferences": [
    ],
  • "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  • "portal_delegates": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Creates a new contact and links it to the currently logged in user

Returns the new contact which is linked to the currently logged in user

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The contact that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this contact

number
number <float> (Number)

The contact number

date_profile_last_updated
string <date-time> (Date Profile Last Updated)

The date that this contact profile was last updated

name
string (Name)

The full name of the contact

full_name
string (Full Name)

Full name

name_last_first
string (Name Last First)

The full name of the contact, last first

organization_id
string (Organization)

The ID of the organization that the contact belongs to

organization_name
string (Organization Name)

The name of the organization; if an organization ID is present, this information is automatically populated

new_organization_info
object (New Organization Info)
contact_role_ids
Array of strings (Contact Roles)

The ids of the contact roles this contact plays in the linked organization.

contact_roles
string (Contact Roles)

READ ONLY - the name of contact roles

job_title
string (Job Title)

The contact's professional title

prefix
string (Prefix)

The contact prefix

salutation
string (Salutation)

The contact salutation

first_name
string (First Name)

The first name

middle_name
string (Middle Name)

The middle name/initial

last_name
string (Last Name)

The last name

maiden_name
string (Maiden Name)

The maiden name

nickname
string (Nickname)

The nickname of the contact

link_work_address_to_organization
boolean (Link Work Address To Organization)

When set, a change in the organization's address changes the contact work address

link_work_phone_number_to_organization
boolean (Link Work Phone Number To Organization)

When set, a change in the organization's phone changes the contact work phone

suffix
string (Suffix)

The contact suffix (Jr., Sr., etc0

credentials
string (Credentials)

Professional credentials/designation (MBA, Esq, PhD, etc)

email_address
string (Email Address)

The primary email address

email_address2
string (Email Address2)

Secondary email address

email_address3
string (Email Address3)

Tertiary email address

mobile_phone_number
string (Mobile Phone Number)

Mobile phone number

work_mobile_phone_number
string (Work Mobile Phone Number)

Mobile phone number for business unit

spouse_id
string (Spouse)

The ID of this person's spouse

home_phone_number
string (Home Phone Number)

Home phone number

work_phone_number
string (Work Phone Number)

Work phone number

fax_phone_number
string (Fax Phone Number)

Fax phone number

school_phone_number
string (School Phone Number)

Fax phone number

preferred_phone_number
string (Preferred Phone Number)

The preferred phone number, calculated based on the preferred phone number type

preferred_phone_number_type
string (Preferred Phone Number Type)

The phone number at which the contact prefers to be reach

Enum: "mobile" "home" "work" "work mobile" "alternate" "school" "fax"
preferred_phone_number_type_id
required
string (Preferred Alternate Phone Number Type)

When a alternate phone number type is preferred, the ID

Array of objects
object (Address)

A complete address

object (Address)

A complete address

object (Address)

A complete address

object (Address)

A complete address

seasonal_address_start
string <date-time> (Seasonal Address Start)

The start date for the seasonal address

seasonal_address_end
string <date-time> (Seasonal Address End)

The end date for the seasonal address

Array of objects
object (Address)

A complete address

preferred_address_type
string (Preferred Address Type)

The address at which the contact prefers to be contacted

Enum: "home" "work" "school" "alternate"
preferred_address_type_id
required
string (Preferred Alternate Address Type)

When a alternate phone number type is preferred, the ID

image_url
string (Image Url)

A url of the image/photo of this contact

gender
string (Gender)

The gender of the contact

Enum: "male" "female"
pronouns
string (Pronouns)
date_of_birth
string <date> (Date Of Birth)

The date of birth of the contact, expressed in ISO-8601 date format

date_of_death
string <date-time> (Date Of Death)

The date this contact passed away

date_social_profile_last_updated
string <date> (Social Profile Last Updated)

The date that the social profile was last updated

notes
string (Notes)

Any contact notes

status
string (Status)

The status of the contact record

Enum: "active" "duplicate" "deceased" "inactive"
Array of objects

A list of previous organization affiliations

facebook
string (Facebook)

Url to the contact's Facebook account

twitter
string (Twitter)

Url to the contact's Twitter account

instagram
string (Instagram)

Url to the contact's Instagram account

linked_in
string (LinkedIn)

Url to the contact's LinkedIn account

user_ids
Array of strings (Users)

A list of related portal user IDs

merged_ids
Array of strings (Mergeds)

A list contact IDs that have been merged into this contact

Array of objects (Custom Field Values)
origin_service
string (Origin Service)

If this contact was created by another service, the service is here

origin_service_record_id
string (Origin Service Record)

If this contact was created by another service, the relevant iD

do_not_mail
boolean (Do Not Mail)

If set, no mail goes to the contact

do_not_call
boolean (Do Not Call)

If so, the person is not to be called

email_opt_out
boolean (Email Opt Out)

This contact has opted out of ALL email communications

Array of objects

The communication types to which this person is subscribed

communication_preferences_last_confirmed
string <date-time> (Communication Preferences Last Confirmed)

The date that the communication preferences were last confirmed for this contact

Array of objects non-empty

Allows for this contact to be managed by other contacts in the portal

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The contact was saved successfully.
400The contact you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The contact could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add contact based on tenant limits.
500General server error.
post/contacts/{tenantId}/current
Request samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "full_name": "string",
  • "name_last_first": "string",
  • "organization_id": "string",
  • "organization_name": "string",
  • "new_organization_info": { },
  • "contact_role_ids": [
    ],
  • "contact_roles": "string",
  • "job_title": "string",
  • "prefix": "string",
  • "salutation": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "maiden_name": "string",
  • "nickname": "string",
  • "link_work_address_to_organization": true,
  • "link_work_phone_number_to_organization": true,
  • "suffix": "string",
  • "credentials": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "spouse_id": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "fax_phone_number": "string",
  • "school_phone_number": "string",
  • "preferred_phone_number": "string",
  • "preferred_phone_number_type": "mobile",
  • "preferred_phone_number_type_id": "string",
  • "other_phone_numbers": [