Invite a contact
Invite a freelancer to your directory.
This endpoint allows clients to add freelancers to their directory. If the email is new to the platform, a new freelancer profile will be created in an invited state and an invitation email will be sent. If the email already exists, the existing freelancer will be added to the client's directory.
**Hirer Attribution (Optional):**
You can optionally provide a `hirer` field with either the hirer's id or email address to specify which user within your organization is adding this contact. If not provided, the system will automatically use the oldest active hirer from your organization.
**Custom Invitation Message (Optional):**
You can optionally provide an `invite_message` field to include a custom message in the invitation email. This is only applicable for new freelancers and will be ignored if the freelancer already exists on the platform.
The freelancer will remain non-bookable until they complete the onboarding process.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
email
The contractor's email address.
first_name
The contractor's first name.
last_name
The contractor's last name.
hirer
The identifier (id) or email address of the hirer who is adding this contact. If not provided, the system will use any active owner from the client.
invite_message
Optional custom message to include in the invitation email sent to the freelancer. Only applicable for new freelancers.
custom_fields
An array of custom fields for the client contact, optional.
Response
data
The client contact object.
This object represents the lifetime relationship between a
client and a freelancer on the platform.
