Skip to main content
POST
/
customers
/
{customerID}
/
businesses
/
invite
Send Business Invite
curl --request POST \
  --url https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "business": {
    "name": "Jim Tester's Electronics",
    "mobile": "6078379283",
    "address_line_1": "123 Main St",
    "address_city": "Orlando",
    "address_state": "FL",
    "address_postal_code": "32801"
  },
  "applicants": [
    {
      "first_name": "Jim",
      "last_name": "Tester",
      "email": "jim.tester@email.com",
      "mobile": "6078379283"
    }
  ]
}
EOF
{
  "status": "success",
  "message": "Business invited successfully",
  "data": {
    "business_id": "e6fbc974-a9d3-4d1b-bd99-90a618758d6d",
    "applicant_email": "jim.tester@email.com",
    "invitation_id": "76fd24c2-c75a-4ab0-8ee7-a1d287d8951b",
    "invitation_url": "https://app.joinworth.com/invite/76fd24c2-c75a-4ab0-8ee7-a1d287d8951b",
    "customer_id": "22f210e4-4455-4107-b132-97e8478546ea"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customerID
string<uuid>
required

Unique identifier of the customer sending the invitation

Example:

"22f210e4-4455-4107-b132-97e8478546ea"

Body

application/json

Business and applicant details for the invitation. Provide either a business object to create a new business, or an existing_business_id / existing_business object to invite applicants to an existing business.

​
applicants
Applicant · object[]
required

List of applicants to invite. At least one applicant is required.

Minimum array length: 1
​
business
object

Details for creating a new business with the invitation. Cannot be used together with existing_business_id or existing_business.

​
existing_business_id
string<uuid>

UUID of an existing business to send the invitation for. Cannot be used together with business or existing_business.

​
existing_business
object

Reference to an existing business with additional context. Cannot be used together with business or existing_business_id.

​
case_id
string<uuid>

UUID of an existing case to associate with the invitation. Only applicable when using existing_business_id or existing_business.

​
existing_applicant_ids
string<uuid>[]

UUIDs of existing applicants to include in the invitation

​
esign_template_id
string<uuid>

UUID of an e-sign template to attach to the invitation

​
esign_templates
string<uuid>[]

List of e-sign template UUIDs to attach to the invitation

​
custom_field_template_id
string<uuid>

UUID of a custom field template to apply to the invitation

​
custom_fields
object

Custom field values to prefill on the invitation, keyed by field identifier

Response

OK

​
status
string
​
message
string
​
data
object