Contact - Create/Update

post

https://api.textinchurch.com/API/1_0/contact.php

Create or update a contact. Exclude hash and id to create, include hash to update.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

contact_id

string

A system generated numerical id for the item. Cannot be altered.

hash

string

A system generated unique id in the form of a hash to obscure numerical id.

account_id

string

The id of the associated account.

contact_first_name

string

The first name of the person.

contact_last_name

string

The last name of the person.

secondary_phone

string

The secondary phone number of the person. Format is numbers only excluding country code. EXAMPLE: 5557453298

secondary_country

string

The two-letter country code for the secondary phone number.

secondary_type

string

The type of phone line for the secondary number (i.e. mobile, landline, voip, etc). The system will automatically lookup this information.

secondary_carrier

string

The carrier who owns the phone line. The system will automatically lookup this information.

primary_phone

string

The primary phone number of the person. Format is numbers only excluding country code. EXAMPLE: 5557453298

primary_country

string

The two-letter country code for the primary phone number.

primary_type

string

The type of phone line for the primary number (i.e. mobile, landline, voip, etc). The system will automatically lookup this information.

primary_carrier

string

The carrier who owns the phone line. The system will automatically lookup this information.

contact_email

string

The email address of the person.

contact_preferred_language

string

The preferred language of the person. Assumes English if blank.

contact_dob

string

deprecated

DEPRECATED. The birthdate of the person. This is now stored in a custom column.

contact_address1

string

The first line of the street address of the person.

contact_address2

string

The second line of the street address of the person.

contact_city

string

The city in the address of the person.

contact_state

string

The state or province in the address of the person.

contact_zip

string

The postal code in the address of the person.

contact_country

string

The two-letter country code of the address of the person.

contact_instagram_url

string

The URL of the person on Instagram.

contact_data_synced

string

deprecated

DEPRECATED. No longer in use.

contact_linkedin_url

string

The URL of the person on Linked-In.

contact_twitter_url

string

The URL of the person on X (formerly Twitter).

contact_facebook_url

string

The URL of the person on Facebook.

contact_image_type

string

The mime type of the image of the person.

contact_image_url

string

The URL to the profile photo of the person.

contact_token

string

deprecated

DEPRECATED. No longer in use.

contact_optout_email

string

Flag indicating whether the person has opted out of email.

opted_out_email_date

string

The date the person opted out of email (if applicable).

contact_optout_sms

string

Flag indicating whether the person has opted out of sms.

opted_out_sms_date

string

The date the person opted out of SMS (if applicable).

opted_in_pft_date

string

The date the preson opted into using a trial phone number.

contact_active

string

Flag indicating whether this contact has been archived or not.

contact_deactivated_date

string

The date the contact was archived.

contact_deactivated_by_user_id

string

The id of the user who archived the contact.

contact_blocked

string

Flag indicating whether the contact is blocked from incoming calls and messages.

contact_pending_email

string

deprecated

DEPRECATED. No longer in use.

contact_data_full

string

deprecated

DEPRECATED. No longer in use.

sent_sms_compliance_msg

string

Flag indicating whether the compliance text message has been sent to the person or not.

contact_connected_accounts

string

List of identifiers from third-party integrations for the contact. Example: PCOID=123,CCB_ID=456

contact_pco_id

string

deprecated

DEPRECATED. No longer in use.

contact_create_date

string

The date the contact record was created.

contact_source

string

The name of the object that created the contact.

contact_source_id

string

The primary id of the object in the other table that created the contact.

contact_reply_date

string

deprecated

DEPRECATED. No longer in use.

contact_stamp

string

The date the contact record was last modified.

contact_is_child

string

Flag indicating whether the record is a person under the age of 18.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK