Overview

This guide provides best practices, key considerations, and sample request bodies to help you successfully POST to Asymbl.

POST Activities

When you POST an Activity, Asymbl creates a matching record and assigns the type as Email or Task.

• Note: activity_type must be EMAIL, NOTE, or OTHER

Example: Create an Attachment as an Email subtype

{
	"model": {
		"body": "Please email this candidate about next steps",
		"user": "{user_uuid}",
		"subject": "Candidate Email Outreach - Next Steps",
		"candidate": "{candidate_uuid}",
		"activity_type": "EMAIL"
	}
}

Example: Create an Activity as a Task subtype

{
	"model": {
		"body": "Candidate Async Assessment ",
		"user": "{user_uuid}",
		"subject": "Candidate Internal Note",
		"candidate": "{candidate_uuid}",
		"activity_type": "NOTE"
	}
}

POST Attachment

Integration parameter:

• path_with_extension : Include the file’s trailing path including its extension. The extension tells Asymbl which attachment format to use.

  • Example: For https://www.{placeholder}.com/fake-resume.pdf, set integration_params.path_with_extension to fake-resume.pdf.

Example: Create an Attachment

{
  "model": {
    "file_url": "https://www.{placeholder}.com/fake-resume.pdf",
    "candidate": "{candidate_uuid}",
    "file_name": "Fake Resume",
    "integration_params": {
      "path_with_extension": "fake_resume.pdf"
    }
  }
}

POST Application

Our POST Application functionality lets you POST with an existing candidate.

In order to customize the source options:

1. Edit the source pick list options:

   1. Go to Salesforce Setup --> Object Manager --> ATS Applicant

   2. Navigate to Fields & Relationships --> Source

   3. Add a Picklist value (ie Merge)

2. Edit the page layout to add source to the UI:

   1. Go to Salesforce Setup --> Object Manager --> ATS Applicant

   2. Navigate to Page Layout

   3. Add the source field to the ATS Applicant Detail page

3. If the source field is still not visible, edit the Lightning App Builder for the record page:

   1. Go to any ATS Applicant record

   2. Click the ⚙icon (top right), click "Edit Page"

4. Custom source fields appear in the UI:

POST Application with existing candidate

Example: Create an application with a existing candidate

{
  "model": {
    "source": "Merge",
    "candidate": "15f63539-d036-42e5-ae96-b18634cd4560",
    "job": "daf09bc2-4878-48a2-a5c9-0c52deea3383"
  }
}

POST Candidate

When adding an email object to email_addresses, include only one email address. For phone numbers, you can set the type to HOME, MOBILE, or OTHER. Only the first city in the locations array will get posted to the candidates record in Asymbl. For locations please only post valid city names.

Email address must be unique. If you try to create a candidate with an existing email address, the post will fail.

Example: Create a candidate

{
  "model": {
    "title": "Software Engineer",
    "last_name": "Doe",
    "first_name": "John",
    "can_email": false,
    "locations": ["San Francisco"]
    "attachments": [],
    "applications": [],
    "phone_numbers": [
      {
        "value": "+1234567890",
        "phone_number_type": "HOME"
      },
      {
        "value": "+1234567890",
        "phone_number_type": "Mobile"
      }
    ],
    "email_addresses": [
      {
        "value": "[email protected]",
        "email_address_type": "Work"
      }
    ]
  }
}