Contacts

Operations

Creates a new contact record that does not already exist.

Request

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.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The contact that you would like to be saved.

communication_preferencesArray of objects

The communication types to which this person is subscribed

communication_preferences_last_confirmedstring, (date-time)(Communication Preferences Last Confirmed)

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

contact_role_idsArray of strings(Contact Roles)

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

contact_rolesstring(Contact Roles)

READ ONLY - the name of contact roles

credentialsstring(Credentials)

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

custom_field_valuesArray of objects(Custom Field Values)

date_of_birthstring, (date)(Date Of Birth)

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

date_of_deathstring, (date-time)(Date Of Death)

The date this contact passed away

date_profile_last_updatedstring, (date-time)(Date Profile Last Updated)

The date that this contact profile was last updated

date_social_profile_last_updatedstring, (date)(Social Profile Last Updated)

The date that the social profile was last updated

do_not_callboolean(Do Not Call)

If so, the person is not to be called

do_not_mailboolean(Do Not Mail)

If set, no mail goes to the contact

email_addressstring(Email Address)

The primary email address

email_address2string(Email Address2)

Secondary email address

email_address3string(Email Address3)

Tertiary email address

email_opt_outboolean(Email Opt Out)

This contact has opted out of ALL email communications

facebookstring(Facebook)

Url to the contact's Facebook account

fax_phone_numberstring(Fax Phone Number)

Fax phone number

first_namestring(First Name)

The first name

full_namestring(Full Name)

Full name

genderstring(Gender)

The gender of the contact

Enum:"female""male"

home_addressobject(Address)

A complete address

home_phone_numberstring(Home Phone Number)

Home phone number

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact

image_urlstring(Image Url)

A url of the image/photo of this contact

instagramstring(Instagram)

Url to the contact's Instagram account

job_titlestring(Job Title)

The contact's professional title

last_namestring(Last Name)

The last name

link_work_address_to_organizationboolean(Link Work Address To Organization)

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

link_work_phone_number_to_organizationboolean(Link Work Phone Number To Organization)

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

linked_instring(LinkedIn)

Url to the contact's LinkedIn account

maiden_namestring(Maiden Name)

The maiden name

merged_idsArray of strings(Mergeds)

A list contact IDs that have been merged into this contact

middle_namestring(Middle Name)

The middle name/initial

mobile_phone_numberstring(Mobile Phone Number)

Mobile phone number

namestring(Name)

The full name of the contact

name_last_firststring(Name Last First)

The full name of the contact, last first

national_districtstring(National District)

The name of the United States congressional district

national_district_ocdIdstring(National District OCD-ID)

The Open Civic Data division identifier of the United States congressional district

new_organization_infoobject(New Organization Info)

nicknamestring(Nickname)

The nickname of the contact

notesstring(Notes)

Any contact notes

numbernumber, (float)(Number)

The contact number

organization_historyArray of objects

A list of previous organization affiliations

organization_idstring(Organization)

The ID of the organization that the contact belongs to

organization_namestring(Organization Name)

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

origin_servicestring(Origin Service)

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

origin_service_record_idstring(Origin Service Record)

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

other_addressesArray of objects

other_phone_numbersArray of objects

override_automatic_region_assignmentboolean(Override Automatic Region Assignment)

If true, the region assignment for this record is overridden and should not be automatically assigned

portal_delegatesArray of objects, non-empty

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

preferred_addressobject(Address)

A complete address

preferred_address_typestring(Preferred Address Type)

The address at which the contact prefers to be contacted

Enum:"alternate""home""school""work"

preferred_address_type_idstring(Preferred Alternate Address Type)required

When a alternate phone number type is preferred, the ID

preferred_phone_numberstring(Preferred Phone Number)

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

preferred_phone_number_typestring(Preferred Phone Number Type)

The phone number at which the contact prefers to be reach

Enum:"alternate""fax""home""mobile""school""work""work mobile"

preferred_phone_number_type_idstring(Preferred Alternate Phone Number Type)required

When a alternate phone number type is preferred, the ID

prefixstring(Prefix)

The contact prefix

pronounsstring(Pronouns)

region_idstring(Region)

The region

salutationstring(Salutation)

The contact salutation

school_addressobject(Address)

A complete address

school_phone_numberstring(School Phone Number)

Fax phone number

seasonal_addressobject(Address)

A complete address

seasonal_address_endstring, (date-time)(Seasonal Address End)

The end date for the seasonal address

seasonal_address_startstring, (date-time)(Seasonal Address Start)

The start date for the seasonal address

spouse_idstring(Spouse)

The ID of this person's spouse

state_lower_districtstring(State Lower District)

The name of the US state lower (House) district

state_lower_district_ocdIdstring(State Lower District OCD-ID)

The Open Civic Data division identifier of the US state lower (House) district

state_upper_districtstring(State Upper District)

The name of the US state upper (Senate) district

state_upper_district_ocdIdstring(State Upper District OCD-ID)

The Open Civic Data division identifier of the US state upper (Senate) district

statusstring(Status)

The status of the contact record

Enum:"active""deceased""duplicate""inactive"

suffixstring(Suffix)

The contact suffix (Jr., Sr., etc0

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber, (float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring, (date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring, (date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber, (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_versionnumber, (float)(Sys Version)

A number representing the version of this record in the database

twitterstring(Twitter)

Url to the contact's Twitter account

user_idsArray of strings(Users)

A list of related portal user IDs

work_addressobject(Address)

A complete address

work_mobile_phone_numberstring(Work Mobile Phone Number)

Mobile phone number for business unit

work_phone_numberstring(Work Phone Number)

Work phone number

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "communication_preferences": [
      {
        "communication_type_id": "string",
        "enabled": true,
        "subscription_email_address": "string",
        "subscription_last_updated": "2019-08-24T14:15:22Z",
        "subscription_status": "digest"
      }
    ],
    "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
    "contact_role_ids": [
      "string"
    ],
    "contact_roles": "string",
    "credentials": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date_of_birth": "2019-08-24",
    "date_of_death": "2019-08-24T14:15:22Z",
    "date_profile_last_updated": "2019-08-24T14:15:22Z",
    "date_social_profile_last_updated": "2019-08-24",
    "do_not_call": true,
    "do_not_mail": true,
    "email_address": "string",
    "email_address2": "string",
    "email_address3": "string",
    "email_opt_out": true,
    "facebook": "string",
    "fax_phone_number": "string",
    "first_name": "string",
    "full_name": "string",
    "gender": "female",
    "home_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "home_phone_number": "string",
    "id": "string",
    "image_url": "string",
    "instagram": "string",
    "job_title": "string",
    "last_name": "string",
    "link_work_address_to_organization": true,
    "link_work_phone_number_to_organization": true,
    "linked_in": "string",
    "maiden_name": "string",
    "merged_ids": [
      "string"
    ],
    "middle_name": "string",
    "mobile_phone_number": "string",
    "name": "string",
    "name_last_first": "string",
    "national_district": "string",
    "national_district_ocdId": "string",
    "new_organization_info": {},
    "nickname": "string",
    "notes": "string",
    "number": 0.1,
    "organization_history": [
      {
        "contact_role_ids": [
          "string"
        ],
        "end_date": "2019-08-24",
        "job_title": "string",
        "notes": "string",
        "organization_id": "string",
        "start_date": "2019-08-24"
      }
    ],
    "organization_id": "string",
    "organization_name": "string",
    "origin_service": "string",
    "origin_service_record_id": "string",
    "other_addresses": [
      {
        "address": {
          "city": "string",
          "country": "string",
          "country_name": "string",
          "county": "string",
          "latitude": 0.1,
          "line1": "string",
          "line2": "string",
          "line3": "string",
          "longitude": 0.1,
          "postal_code": "string",
          "state": "string",
          "time_zone_id": "string"
        },
        "type_id": "string"
      }
    ],
    "other_phone_numbers": [
      {
        "phone_number": "string",
        "type_id": "string"
      }
    ],
    "override_automatic_region_assignment": true,
    "portal_delegates": [
      {
        "contact_id": "string",
        "expiration_date": "2019-08-24T14:15:22Z",
        "status": "approved"
      }
    ],
    "preferred_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "preferred_address_type": "alternate",
    "preferred_address_type_id": "string",
    "preferred_phone_number": "string",
    "preferred_phone_number_type": "alternate",
    "preferred_phone_number_type_id": "string",
    "prefix": "string",
    "pronouns": "string",
    "region_id": "string",
    "salutation": "string",
    "school_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "school_phone_number": "string",
    "seasonal_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "seasonal_address_end": "2019-08-24T14:15:22Z",
    "seasonal_address_start": "2019-08-24T14:15:22Z",
    "spouse_id": "string",
    "state_lower_district": "string",
    "state_lower_district_ocdId": "string",
    "state_upper_district": "string",
    "state_upper_district_ocdId": "string",
    "status": "active",
    "suffix": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "twitter": "string",
    "user_ids": [
      "string"
    ],
    "work_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "work_mobile_phone_number": "string",
    "work_phone_number": "string"
  }'

Responses

The contact was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

communication_preferencesArray of objects

The communication types to which this person is subscribed

communication_preferences_last_confirmedstring, (date-time)(Communication Preferences Last Confirmed)

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

contact_role_idsArray of strings(Contact Roles)

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

contact_rolesstring(Contact Roles)

READ ONLY - the name of contact roles

credentialsstring(Credentials)

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

custom_field_valuesArray of objects(Custom Field Values)

date_of_birthstring, (date)(Date Of Birth)

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

date_of_deathstring, (date-time)(Date Of Death)

The date this contact passed away

date_profile_last_updatedstring, (date-time)(Date Profile Last Updated)

The date that this contact profile was last updated

date_social_profile_last_updatedstring, (date)(Social Profile Last Updated)

The date that the social profile was last updated

do_not_callboolean(Do Not Call)

If so, the person is not to be called

do_not_mailboolean(Do Not Mail)

If set, no mail goes to the contact

email_addressstring(Email Address)

The primary email address

email_address2string(Email Address2)

Secondary email address

email_address3string(Email Address3)

Tertiary email address

email_opt_outboolean(Email Opt Out)

This contact has opted out of ALL email communications

facebookstring(Facebook)

Url to the contact's Facebook account

fax_phone_numberstring(Fax Phone Number)

Fax phone number

first_namestring(First Name)

The first name

full_namestring(Full Name)

Full name

genderstring(Gender)

The gender of the contact

Enum:"female""male"

home_addressobject(Address)

A complete address

home_phone_numberstring(Home Phone Number)

Home phone number

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact

image_urlstring(Image Url)

A url of the image/photo of this contact

instagramstring(Instagram)

Url to the contact's Instagram account

job_titlestring(Job Title)

The contact's professional title

last_namestring(Last Name)

The last name

link_work_address_to_organizationboolean(Link Work Address To Organization)

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

link_work_phone_number_to_organizationboolean(Link Work Phone Number To Organization)

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

linked_instring(LinkedIn)

Url to the contact's LinkedIn account

maiden_namestring(Maiden Name)

The maiden name

merged_idsArray of strings(Mergeds)

A list contact IDs that have been merged into this contact

middle_namestring(Middle Name)

The middle name/initial

mobile_phone_numberstring(Mobile Phone Number)

Mobile phone number

namestring(Name)

The full name of the contact

name_last_firststring(Name Last First)

The full name of the contact, last first

national_districtstring(National District)

The name of the United States congressional district

national_district_ocdIdstring(National District OCD-ID)

The Open Civic Data division identifier of the United States congressional district

new_organization_infoobject(New Organization Info)

nicknamestring(Nickname)

The nickname of the contact

notesstring(Notes)

Any contact notes

numbernumber, (float)(Number)

The contact number

organization_historyArray of objects

A list of previous organization affiliations

organization_idstring(Organization)

The ID of the organization that the contact belongs to

organization_namestring(Organization Name)

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

origin_servicestring(Origin Service)

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

origin_service_record_idstring(Origin Service Record)

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

other_addressesArray of objects

other_phone_numbersArray of objects

override_automatic_region_assignmentboolean(Override Automatic Region Assignment)

If true, the region assignment for this record is overridden and should not be automatically assigned

portal_delegatesArray of objects, non-empty

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

preferred_addressobject(Address)

A complete address

preferred_address_typestring(Preferred Address Type)

The address at which the contact prefers to be contacted

Enum:"alternate""home""school""work"

preferred_address_type_idstring(Preferred Alternate Address Type)required

When a alternate phone number type is preferred, the ID

preferred_phone_numberstring(Preferred Phone Number)

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

preferred_phone_number_typestring(Preferred Phone Number Type)

The phone number at which the contact prefers to be reach

Enum:"alternate""fax""home""mobile""school""work""work mobile"

preferred_phone_number_type_idstring(Preferred Alternate Phone Number Type)required

When a alternate phone number type is preferred, the ID

prefixstring(Prefix)

The contact prefix

pronounsstring(Pronouns)

region_idstring(Region)

The region

salutationstring(Salutation)

The contact salutation

school_addressobject(Address)

A complete address

school_phone_numberstring(School Phone Number)

Fax phone number

seasonal_addressobject(Address)

A complete address

seasonal_address_endstring, (date-time)(Seasonal Address End)

The end date for the seasonal address

seasonal_address_startstring, (date-time)(Seasonal Address Start)

The start date for the seasonal address

spouse_idstring(Spouse)

The ID of this person's spouse

state_lower_districtstring(State Lower District)

The name of the US state lower (House) district

state_lower_district_ocdIdstring(State Lower District OCD-ID)

The Open Civic Data division identifier of the US state lower (House) district

state_upper_districtstring(State Upper District)

The name of the US state upper (Senate) district

state_upper_district_ocdIdstring(State Upper District OCD-ID)

The Open Civic Data division identifier of the US state upper (Senate) district

statusstring(Status)

The status of the contact record

Enum:"active""deceased""duplicate""inactive"

suffixstring(Suffix)

The contact suffix (Jr., Sr., etc0

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber, (float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring, (date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring, (date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber, (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_versionnumber, (float)(Sys Version)

A number representing the version of this record in the database

twitterstring(Twitter)

Url to the contact's Twitter account

user_idsArray of strings(Users)

A list of related portal user IDs

work_addressobject(Address)

A complete address

work_mobile_phone_numberstring(Work Mobile Phone Number)

Mobile phone number for business unit

work_phone_numberstring(Work Phone Number)

Work phone number

Response

{
  "communication_preferences": [
    { … }
  ],
  "communication_preferences_last_confirmed": "2019-08-24T14:15:22Z",
  "contact_role_ids": [
    "string"
  ],
  "contact_roles": "string",
  "credentials": "string",
  "custom_field_values": [
    { … }
  ],
  "date_of_birth": "2019-08-24",
  "date_of_death": "2019-08-24T14:15:22Z",
  "date_profile_last_updated": "2019-08-24T14:15:22Z",
  "date_social_profile_last_updated": "2019-08-24",
  "do_not_call": true,
  "do_not_mail": true,
  "email_address": "string",
  "email_address2": "string",
  "email_address3": "string",
  "email_opt_out": true,
  "facebook": "string",
  "fax_phone_number": "string",
  "first_name": "string",
  "full_name": "string",
  "gender": "female",
  "home_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "home_phone_number": "string",
  "id": "string",
  "image_url": "string",
  "instagram": "string",
  "job_title": "string",
  "last_name": "string",
  "link_work_address_to_organization": true,
  "link_work_phone_number_to_organization": true,
  "linked_in": "string",
  "maiden_name": "string",
  "merged_ids": [
    "string"
  ],
  "middle_name": "string",
  "mobile_phone_number": "string",
  "name": "string",
  "name_last_first": "string",
  "national_district": "string",
  "national_district_ocdId": "string",
  "new_organization_info": {},
  "nickname": "string",
  "notes": "string",
  "number": 0.1,
  "organization_history": [
    { … }
  ],
  "organization_id": "string",
  "organization_name": "string",
  "origin_service": "string",
  "origin_service_record_id": "string",
  "other_addresses": [
    { … }
  ],
  "other_phone_numbers": [
    { … }
  ],
  "override_automatic_region_assignment": true,
  "portal_delegates": [
    { … }
  ],
  "preferred_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "preferred_address_type": "alternate",
  "preferred_address_type_id": "string",
  "preferred_phone_number": "string",
  "preferred_phone_number_type": "alternate",
  "preferred_phone_number_type_id": "string",
  "prefix": "string",
  "pronouns": "string",
  "region_id": "string",
  "salutation": "string",
  "school_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "school_phone_number": "string",
  "seasonal_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "seasonal_address_end": "2019-08-24T14:15:22Z",
  "seasonal_address_start": "2019-08-24T14:15:22Z",
  "spouse_id": "string",
  "state_lower_district": "string",
  "state_lower_district_ocdId": "string",
  "state_upper_district": "string",
  "state_upper_district_ocdId": "string",
  "status": "active",
  "suffix": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "twitter": "string",
  "user_ids": [
    "string"
  ],
  "work_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "work_mobile_phone_number": "string",
  "work_phone_number": "string"
}

Contacts

Creates a new contact record that does not already exist.

Request

Path

Responses

Was this helpful?