ConveYour API Documentation

Who is this documentation for?

This documentation is for anyone with a conveyour.com account who is looking to programmatically interact with their account.

How do I get API credentials?

To get started with integrations, get the App key and Token from Settings > Integrations > Analytics

https://conveyour.com/help/conveyour-analytics-rest-api

For credentials with greater access than the provided integrations, please reach out to support at [email protected].

Analytics

With ConveYour's analytics you can identify users, see when they last visited, sync user data to your ConveYour account, and monitor user behavior.

For more information reference https://conveyour.com/help/conveyour-analytics-rest-api

Identify

Method: POST

URL: {{host}}/api/analytics/identify

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "id" : "$recruit_id,$badge_number",
    "traits" : {
      "first_name": "Steve",
      "last_name": "Rhino",
      "recruit_id" : "1"
    }
}

Contacts

ConveYour provides multiple ways to manage and work with your contacts.

For more information reference https://conveyour.com/help/contacts-an-overview

Metrics

Metics allows you to monitor the progress of learners through lessons and campaigns.

Method: N/A

URL: N/A

Retrieving Contacts

This sections is dedicated to

Method: N/A

URL: N/A

Editing Contacts

Method: N/A

URL: N/A

Other Contact Operations

Method: N/A

URL: N/A

Campaigns

Campaigns are used by ConveYour customers to build training courses, schedule the delivery of SMS and email messages; and automate internal things like tagging contacts, adding contacts to campaigns, etc.

For more information reference https://conveyour.com/help/categories/campaigns

Get Campaigns

Method: GET

URL: {{host}}/api/campaigns

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Get Campaigns Export

Method: GET

URL: {{host}}/api/campaigns/export/{{campaign_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Campaigns Import

Method: POST

URL: {{host}}/api/campaigns/templates

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "version": "1.0",
    "metadata": {
        "exported_by": {
            "org_id": 147,
            "org_domain": "dev",
            "user_id": 271,
            "user_name": "Christian Campbell...."
        },
        "timestamp": 1702647361
    },
    "campaign": {
        "uuid": "campaign_657c5641ea226",
        "type": "workflow",
        "name": "New Workflow Campaign",
        "banner_img": "https:\/\/dev.conveyour.io\/img\/ui\/banners\/default.jpg",
        "info": "\n",
        "button_text": "Join Us",
        "mobile": "required",
        "landing_css": "",
        "avoid_contact_updates": false,
        "timezone": "Europe\/Athens",
        "start_time": "2023-12-07",
        "end_time": "2028-12-07 00:00",
        "confirm_form": "Thank you for joining! You will receive a link to participate soon.",
        "confirm_response": "Welcome to the {{campaign_name}}. Follow the link provided to participate from your personalized portal. No need to login! {{url}}",
        "confirm_email_subject": "Welcome to {{campaign_name}}",
        "confirm_email_response": "Hello {{first_name or \"there\"}},<br><br>Thank you for joining! Follow the link below to your personalized portal. No need to login.<br><br>Here is your link to participate:<br>{{url}}",
        "hash_tag": "",
        "lock_order": false,
        "invites": false,
        "progress_permissions": [
            "none"
        ],
        "days": [
            "mon",
            "tue",
            "wed",
            "thu",
            "fri",
            "sat",
            "sun"
        ]
    },
    "triggers": [
        {
            "uuid": "trigger_657c5641f3b3e",
            "type": "lesson",
            "name": "Two Signwell",
            "notes": "",
            "delay": 0,
            "start_at": "00:01",
            "automatic": false,
            "end_days": 0,
            "join_delay": false,
            "order": 1,
            "bookmark_id": "",
            "wf_if": "",
            "wf_detached": false,
            "days": [],
            "include_extra_lessons": false,
            "passing_grade_required": false,
            "passing_grade": 80,
            "failure_message": "Aw shucks! You did not get a passing grade. But that's OK! Please try again.",
            "failure_gif": true,
            "expire_days": 0,
            "banner_img": "",
            "send_alert": "sms",
            "notify_sms": "{{first name OR \"Hi\"}}, there's new {{campaign_name}} content available for you. Here's your link. \n\n{{url}}",
            "notify_email_subject": "{{first name OR \"Hi\"}}, there's new {{campaign_name}} content available!",
            "notify_email_body": "{{first name OR \"Hi\"}}, <br><br>There is new {{campaign_name}} content available for you. <br><br><a href=\"{{url}}\">Here's your link to answer &amp; get more points!<\/a><br>",
            "force_send_alert": false,
            "parent_trigger": "",
            "wf_async": false,
            "lesson": {
                "name": "Two Signwell",
                "items": [
                    {
                        "type": "signwell",
                        "values": {
                            "template_id": "1d23e115-0113-4d40-93aa-36d5e7bde430",
                            "placeholder_name": "Signer",
                            "button_text": "Sign Agreement",
                            "success_text": "Thank you! You are all set here.",
                            "prefilled_fields": [
                                {
                                    "key": "name",
                                    "value": "{{name}}"
                                }
                            ],
                            "test_mode": false,
                            "open_popup": true,
                            "can_advance": false,
                            "wrong_answer": 0,
                            "answer_points": 0,
                            "multiplier": 0,
                            "max": 0
                        },
                        "editing": true,
                        "uuid": "ec917ff2-07aa-4f24-a41a-1e16c6d38c6f",
                        "name": ""
                    }
                ],
                "banner_img": "https:\/\/i.ytimg.com\/vi\/fqlH7di8oI4\/hqdefault.jpg",
                "length": "30 sec",
                "tags": [],
                "items_count": 1,
                "uuid": "6f8a3060-fe9d-11eb-8b1a-3b25e6747d5f",
                "isDirty": false,
                "updated_at": 1702489886,
                "created_at": 1629123770,
                "etl": false,
                "schemaLevel": "full",
                "icon": "signwell",
                "selected": false
            }
        },
        {
            "uuid": "trigger_657c564201bbc",
            "type": "wait",
            "name": "Wait",
            "notes": "",
            "delay": 0,
            "start_at": "00:01",
            "automatic": false,
            "end_days": 0,
            "join_delay": false,
            "order": 1,
            "bookmark_id": "",
            "wf_pid": "trigger_657c5641f3b3e",
            "wf_if": "",
            "wf_detached": false,
            "days": [],
            "conditions": [
                {
                    "is": "yes",
                    "when": "all",
                    "match": [
                        {
                            "in": {
                                "user_id": "271",
                                "name": "Wait trigger name",
                                "filters": "{\"$and\":[],\"$records\":[[{\"event\":{\"$eq\":\"completed_lesson\"}},{\"date\":{\"$gt\":\"30\"}},{\"396.lesson\":{\"$eq\":\"trigger_657c5641f3b3e\"}}]]}",
                                "default_for": [],
                                "share_to": [],
                                "for": "trigger",
                                "teams": [],
                                "updated_at": 1702647291,
                                "created_at": 1702647291
                            }
                        }
                    ]
                },
                {
                    "is": "no",
                    "when": "all",
                    "match": [
                        {
                            "bool": true
                        }
                    ]
                }
            ],
            "wait_for": "1 day ",
            "enable_nudges": false,
            "nudges": [
                "+15min",
                "+1day",
                "+7days"
            ],
            "send_alert": "sms",
            "notify_sms": "Hi {{first_name}},\n{% if nudge.n < 4 %}\nThis is a friendly reminder to complete steps assigned to you.\n{% elsif nudge.n < 7 %}\nYour window to complete your assigned steps is closing soon. This is your {{nudge.ord}} reminder. Please complete these steps as soon as you can.\n{% else %}\nThis is your FINAL reminder to complete steps assigned to you.\n{% endif %}\nThank you! Here is your link.\n{{url}}",
            "notify_email_subject": "{{nudge.ord}} reminder to complete steps.",
            "notify_email_body": "Hi {{first_name}}, <br><br>\n{% if nudge.n < 4 %}<br><br>\nThis is a friendly reminder to complete steps assigned to you.\n{% elsif nudge.n < 7 %}<br><br>\nYour window to complete your assigned steps is closing soon. This is your {{nudge.ord}} reminder. Please complete these steps as soon as you can.\n{% else %}<br><br>\nThis is your FINAL reminder to complete steps assigned to you.\n{% endif %}<br><br>\nThank you! Here is your link.\n<br><br>\nThank you! <a href=\"{{url}}\">Here is your link.<\/a><br>",
            "force_send_alert": false
        }
    ]
}

Get Default Campaign

Method: GET

URL: {{host}}/api/campaigns/default

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Get Campaign Funnel

Method: GET

URL: {{host}}/api/campaigns/funnel/{{campaign_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Triggers

Use Triggers to schedule SMS and email messages, release lessons, automate tagging of contacts or pushing contacts onto other campaigns. Triggers are "triggered" to release based on their timing configuration. You can think of them as like little cron jobs waiting for their time to start looking for contacts that apply and then run the configuration.

Get Triggers

Method: GET

URL: {{host}}/api/triggers?campaign={{campaign_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Create Trigger

Method: POST

URL: {{host}}/api/triggers

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
	"type":"sms",
	"campaign_id":"{{campaign_id}}",
	"draft":true,
	"name":"New Send SMS Message",
	"bookmark_id":"{{bookmark_id}}"
}

Validate Trigger

Method: POST

URL: {{host}}/api/triggers/validate

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
	"name":"New Send SMS Message",
	"sending_user_id":"4",
	"bookmark_id":"5cd432f11c337ad2548b45a0",
	"delay":0,
	"start_date":"2019-05-09",
	"start_at":"00:01",
	"join_delay":false,
	"order":1,
	"days":[],
	"body":"Hello {{first name OR \"there\"}}, example message.",
	"media":null,
	"automatic":false,
	"type":"sms",
	"campaign_id":"{{campaign_id}}",
	"interval":"* * * * *",
	"timezone":"America/Chicago",
	"user_id":4,
	"org_id":2,
	"id":"5cd441d01c337aab158b4567",
	"bookmark":""
}

Update Trigger

Method: PUT

URL: {{host}}/api/triggers/{{trigger_id}}

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "name": "New Lesson: Oct 5th at 3:13pm",
    "bookmark_id": "",
    "lesson_id": "633de55776464500db269d63",
    "reset_cron": null,
    "wf_async": false,
    "wf_if": "",
    "wf_pid": null,
    "parent_trigger": "",
    "include_extra_lessons": false,
    "delay": 0,
    "start_date": null,
    "start_at": "09:00",
    "join_delay": false,
    "order": 1,
    "days": [],
    "bookmark": "",
    "expire_days": 0,
    "banner_img": "",
    "passing_grade_required": false,
    "passing_grade": 80,
    "failure_message": "Aw shucks! You did not get a passing grade. But that's OK! Please try again.",
    "failure_gif": true,
    "send_alert": "sms",
    "reply_id": "6042806d8aa51400414d48d1",
    "notify_sms": "{{first name OR \"Hi\"}}, there's new {{campaign_name}} content available for you. Here's your link. \n\n{{url}}",
    "notify_email_subject": "{{first name OR \"Hi\"}}, there's new {{campaign_name}} content available!",
    "sender_id": "",
    "notify_email_body": "{{first name OR \"Hi\"}}, <br><br>There is new {{campaign_name}} content available for you. <br><br><a href=\"{{url}}\">Here's your link to answer &amp; get more points!</a><br>",
    "automatic": false,
    "end_days": 0,
    "type": "lesson",
    "campaign_id": "{{campaign_id}}",
    "interval": "* * * * *",
    "timezone": "America/Chicago",
    "valid": true,
    "start_time": 1701410460,
    "end_time": 1851397200,
    "draft": true,
    "user_id": 4,
    "org_id": 2,
    "is_wf_trigger": false,
    "etl": true,
    "id": "64f1ef846780ee00a5409223",
    "sorting_time": 1701410460,
    "_vanity": {
        "user_id": "Mr Bean",
        "user": "Mr Bean",
        "org_id": "Acme",
        "org": "Acme",
        "campaign_id": "Draft",
        "campaign": "Draft",
        "bookmark_id": "",
        "bookmark": "",
        "wf_pid": "",
        "wfParentTrigger": "",
        "sender_id": "",
        "sender": "",
        "reply_id": "Stephen Rhyne",
        "reply": "Stephen Rhyne",
        "lesson_id": "New Lesson: Oct 5th at 3:13pm",
        "lesson": "New Lesson: Oct 5th at 3:13pm"
    },
    "previewable": true,
    "lesson_name": "New Lesson: Oct 5th at 3:13pm",
    "lesson_length": "1 min, 0 sec",
    "lesson_banner_img": "http://i.ytimg.com/vi/zlRl8sJU_4I/hqdefault.jpg",
    "lesson_items_count": 3,
    "status": "draft"
}

Users

Users in your ConveYour account can be classified as either admins or guests, each with distinct access levels and privileges.

Get Current User

Method: GET

URL: {{host}}/api/users/current

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Get Users

Method: GET

URL: {{host}}/api/users?deleted=true

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Restore User

Method: PUT

URL: {{host}}/api/users/restore/{{user_id}}

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Delete User

Method: DELETE

URL: {{host}}/api/users/{{user_id}}

Portal

Requests made by the learner inside the learner portal.
The api end point for all of these requests is https?://{orgdomain}.conveyour.{tld}/api/cg/

Auth

This section provides guidance on managing authentication requests in the learner portal and how to handle contact access via the API.

Method: N/A

URL: N/A

Profile Info

This section outlines the methods to retrieve and update a learner's profile information. Additionally, it covers procedures for updating and removing device tokens associated with a learner's profile.

Method: N/A

URL: N/A

Content

This section details the methods for retrieving a learner's courses, lessons, and campaigns within the Learner Portal. It also instructs on how to cancel a learner's subscription via the API.

Method: N/A

URL: N/A

Conversations - BETA

The conversation end-points allow you to pull threads, messages, and send messages to contacts.

Method: N/A

URL: N/A

Lessons

This section provides a guide on handling lessons within the API, detailing steps for listing, updating, organizing, and deleting lessons.

For more information reference https://conveyour.com/help/categories/lessons

Folders

Method: N/A

URL: N/A

Get Lesson

Method: GET

URL: {{host}}/api/lessons/{{lesson_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Count Lessons

Method: GET

URL: {{host}}/api/lessons/?count=1

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Search lessons

Method: GET

URL: {{host}}/api/lessons/search?query=New

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Lessons/Item/Trigger shared anwsers

Method: GET

URL: {{host}}/api/lessons/{{lesson_id}}/shared/{{item_uuid}}

Headers:

CONCO-PID: {{contact_public_id}}
x-conveyour-trigger: {{trigger_id}}
Content-Type: application/json

Lesson related items

Method: GET

URL: {{host}}/api/lessons/{{lesson_id}}/related

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Delete item

Method: DELETE

URL: {{host}}/api/lessons/{{lesson_id}}/items/{{item_uuid}}

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Update Lesson

Method: PUT

URL: {{host}}/api/lessons/{{lesson_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "schemaLevel": "full",
    "banner_img": "",
    "items": [
        {
            "type": "rich_text",
            "values": {
                "body": "<p>This is text content</p>",
                "standnew": false,
                "metadata": [],
                "wrong_answer": 0,
                "answer_points": 0,
                "multiplier": 0,
                "max": 0
            },
            "editing": false,
            "uuid": "5a22ea50-51a7-11ee-bf30-438ae53ca467"
        }
    ],
    "tags": [],
    "name": "A Lesson Name",
    "uuid": "{{lesson_id}}",
    "deleted_at": null
}

Reports

Reports offer a collection of reports on your contacts and their engagement throughout the platform.

For more information on the available reports reference https://conveyour.com/help/categories/reporting or visit the reports section of the admin panel.

Get Report List

Method: GET

URL: {{host}}/api/reports

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Get Campaign Performance Report

Method: GET

URL: {{host}}/api/reports/campaignPerformance?data=1&campaign_id={{campaign_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Bookmarks (Groups)

This section outlines the procedures related to bookmarks (also known as Groups) within the API. It covers the processes for creating, listing, updating, organizing, and deleting these bookmarks.

For more information reference https://conveyour.com/help/categories/groups

Folders

Method: N/A

URL: N/A

Get Bookmarks

Method: GET

URL: {{host}}/api/bookmarks

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Get Bookmark By ID

Method: GET

URL: {{host}}/api/bookmarks/{{bookmark_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Create Bookmark

Method: POST

URL: {{host}}/api/bookmarks

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "name": "New Bookmark (Group)",
    "filters": {
         "$and": [
                {
                    "3.tags": {
                        "$in": [
                            "success",
                            "test"
                        ]
                    }
                },
                {
                    "3.department": {
                        "$in": [
                            "Marketing"
                        ]
                    }
                }
            ]
    }
}

Update Bookmark

Method: PUT

URL: {{host}}/api/bookmarks/{{bookmark_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "name": "New Updated name"
}

Delete Bookmark

Method: DELETE

URL: {{host}}/api/bookmarks/{{bookmark_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Search Bookmarks

Method: GET

URL: {{host}}/api/bookmarks/search?query=BookmarkName

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Auth

This section delves into the management of authorized services for your Conveyour account. It provides guidance on creating, updating, and deleting services that have permissions to take specific actions on the account.

For more information about integrated services reference https://conveyour.com/help/categories/intergations

List Auths

Method: GET

URL: {{host}}/api/auths

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Create Auth

Method: POST

URL: {{host}}/api/auths

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "provider": "scorm"
    // "oauth_token" : ""
    // , 
    // "access_token": "XYZ"
}

Update Auth

Method: PUT

URL: {{host}}/api/auths/{{auth_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "provider": "provider_name"
}

Delete Auth

Method: DELETE

URL: {{host}}/api/auths/{{auth_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Messages

Thread Assignments

Method: N/A

URL: N/A

Send Message

Method: POST

URL: {{host}}/api/messages

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
  "body": "snippet(asset_table)",
  "class": "email",
  "type": "contact",
  "subject": "test asset email",
  "format": "html",
  "type_id": "65b7f9edae62a2b0d76a7793",
  "teams" : [ "{{team_id}}" ],
  "inputs" : { 
     "assets" : [
            { "rep_name" : "John Smith", "badge_number" : 1234, "asset_number" : 1 },
            { "rep_name" : "Jane Smith", "badge_number" : 5678, "asset_number" : 2 },
            { "rep_name" : "Melissa Myers", "badge_number" : 1255, "asset_number" : 3 }
       ] 
  }
}

Snippets

Snippets are reusable chunks of HTML and plain text content. This section will cover how to create, modify, and delete snippets via the API. To learn more reference https://conveyour.com/help/snippets.

Get Snippets

Method: GET

URL: {{host}}/api/snippets

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Create Snippet

Method: POST

URL: {{host}}/api/snippets

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "content": "<p>testing this out</p>",
    "folder_id": "{{snippets_folder_id}}",
    "name": "testing this out",
    "shortcut": "test",
    "text_content": "Hello {{contact.first_name}}!\n",
    "files": [
        "{{file_id}}"
    ]
}

Update Snippet

Method: PUT

URL: {{host}}/api/snippets/{{snippet_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "name": "Hello Example",
    "content" : "<p>Hello {{contact.first_name}}</p>",
    "text_content" : "Hello {{contact.first_name}}",
    "shortcut" : "hello_example"
}

Update HTML for Snippet Directly

Method: PUT

URL: {{host}}/api/snippets/html/{{snippet_id}}?teams={{team_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

<p>Hello {{contact.first_name}},</p>
<p>This is an example of updating the HTML version of a snippet.</p>

Delete Snippet

Method: DELETE

URL: {{host}}/api/snippets/{{snippet_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Fields

Get fields

Method: GET

URL: {{host}}/api/fields

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Create field

Method: POST

URL: {{host}}/api/fields

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "bucket_id": 7,
    "name": "dummy",
    "label": "Dummy",
    "type": "related_contacts",
    "filters":{"$where":[{"7.company":{"$eq":"Softstart"}}]}
}

Update field

Method: GET

URL: {{host}}/api/fields/387

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "custom_object_field_map": {
        "address": "work_office_address",
        "country": "work_office_country",
        "zip": "work_office_zip"
    }
}

Delete field

Method: DELETE

URL: {{host}}/api/fields/{{field_id}}

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Compliance - BETA

Run Compliance

Method: POST

URL: {{host}}/api/compliance

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "contact_query" : {
        "badge_number"  : "9012316"
    },
    "content_query" : {
        "lesson_tags" : {
            "all" : [ "sg_access" ]
        },
        "released_only" : true
    },
    "include_lessons" : true,
    "callback_url" : ""
}

Custom Objects - BETA

List Custom Objects

Method: GET

URL: {{host}}/api/custom/objects

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Retrieve Custom Object

Method: GET

URL: {{host}}/api/custom/objects/62c895c4641007091d773770

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Schema - Custom Objects

Method: GET

URL: {{host}}/api/custom/objects/schema

Headers:

Content-Type: application/json
x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Create Custom Object

Method: POST

URL: {{host}}/api/custom/objects

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "name" : "family_member",
    "label" : "Family Member",
    "label_plural" : "Family Members"
}

Update - Custom Object

Method: PUT

URL: {{host}}/api/custom/objects/62d1d01f6aee0d0a035af3f3

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
     "schema" : {
        "customer_name": {
            "title" : "Customer Name",
            "type" : "Text",
            "validators" : [ "required" ]
        },
        "status": {
            "title" : "Status",
            "type" : "Text",
            "validators" : [ "required" ]
        },
        "badge_number": {
            "title": "Rep Badge Number",
            "type" : "Text",
            "validators" : [ "required" ]
        }
    }    
}

Delete - Custom Object

Method: DELETE

URL: {{host}}/api/custom/objects/62c8983e641007091f67a7c2

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

{{host}}/api/cg/reports

Method: GET

URL: {{host}}/api/cg/reports

Headers:

CONCO-PID: {{contact_public_id}}
Content-Type: application/json

Custom Object Records - BETA

List Records

Method: GET

URL: {{host}}/api/custom/records

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Retrieve Record

Method: GET

URL: {{host}}/api/custom/records/62c8b134641007091f67a7c6

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Update - Custom Record

Method: PUT

URL: {{host}}/api/custom/records/62c8b134641007091f67a7c6

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "name" : 29
}

Create - Custom Record

Method: POST

URL: {{host}}/api/custom/records

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
    "obj_id" : "62c8a483641007143a6c2ca6",
    "external_id": "1235",
    "name": "Grace Wong",
    "age" : 64
}

Add Many Custom Records

Method: POST

URL: {{host}}/api/custom/records/add

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

[
    {
        "obj_id": "62c9881564100717c60b6792",
        "external_id": "1235",
        "name": "Grace Wong",
        "age": 63
    },
    {
        "obj_id": "62c9881564100717c60b6792",
        "external_id": "1236",
        "name": "Evan Yu",
        "age": 29
    }
]

Delete - Custom Record

Method: DELETE

URL: {{host}}/api/custom/records/62c8a483641007143a6c2ca6

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Notes

Method: GET

URL: {{host}}/api/notes?notes_scope=all

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Notes

Method: POST

URL: {{host}}/api/notes

Headers:

x-conveyour-appkey: {{app_key}}
x-conveyour-token: {{app_token}}

Body:

{
  "contact_id": "6672df0cc33f1100637bd93c",
  "body": "a",
  "user_id": 4,
  "user_name": "Christian Campbell",
  "all_teams": true

}

Youtube

Get Auth

Method: GET

URL: N/A

Get Auth Copy

Method: POST

URL: {{host}}/connect/youtube

ConveYour API Documentation

Who is this documentation for?

How do I get API credentials?

Analytics

Identify

Contacts

Metrics

Retrieving Contacts

Editing Contacts

Other Contact Operations

Campaigns

Get Campaigns

Get Campaigns Export

Campaigns Import

Get Default Campaign

Get Campaign Funnel

Triggers

Get Triggers

Create Trigger

Validate Trigger

Update Trigger

Users

Get Current User

Get Users

Restore User

Delete User

Portal

Auth

Profile Info

Content

Conversations - BETA

Lessons

Folders

Get Lesson

Count Lessons

Search lessons

Lessons/Item/Trigger shared anwsers

Lesson related items

Delete item

Update Lesson

Reports

Get Report List

Get Campaign Performance Report

Bookmarks (Groups)

Folders

Get Bookmarks

Get Bookmark By ID

Create Bookmark

Update Bookmark

Delete Bookmark

Search Bookmarks

Auth

List Auths

Create Auth

Update Auth

Delete Auth

Messages

Thread Assignments

Send Message

Tags

Get Tags

Create Tag

Update Tag

Delete Tag

Snippets

Get Snippets

Create Snippet

Update Snippet

Update HTML for Snippet Directly

Delete Snippet

Fields

Get fields

Create field

Update field

Delete field

Compliance - BETA

Run Compliance

Custom Objects - BETA

List Custom Objects

Retrieve Custom Object