Create contact

Contacts with emails that already exist for the target sequence will now be processed as they are duplicates. You will receive a success message however.

Create a new contact in Copyfactory

POST https://app.copyfactory.io/api/v2/contact/

Create a new contact in Copyfactory.

Headers

NameTypeDescription

Authorization*

String

Copyfactory API key

Request Body

NameTypeDescription

email*

String

The contacts email.

sequence_id*

int

The ID of the sequence to add the contact to.

playbook_id*

int

The ID of the playbook you want to run for the contact.

linkedin_handle

String

The LinkedIn handle of the contact. Required if using data enrichment.

do_enrichment

Bool

True/False as to enrich the contact.

custom_fields

Object

Custom fields you wish to add for the contact where the key is the name of the custom field in Copyfactory and the value is the value you want to associate to that field.

{
    'data': {'status': 'Contact successfully queued.'}
}
curl --location --request POST 'https://app.copyfactory.io/api/v2/contact/' \
--header 'Authorization: API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": 'email@email.com',
    "sequence_id": 0,
    "linkedin_handle": 'https://www.linkedin.com/in/my-handle/',
    "playbook_id": 0,
    "do_enrichment": False,
    "custom_fields": {'custom_field':'Custom value'},
}'

Last updated