Create Onboarding Invite

POST

https://api.softservv.co/onboarding/invite/

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/x-www-form-urlencoded

Responses

🟢200Success

application/json

Body

🟠400Invalid input

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.softservv.co/onboarding/invite/' \
--header 'Authorization: Bearer <token>' \
--data-urlencode 'company_name=The name of the account being invited' \
--data-urlencode 'plan_guid=The pricing plan guid' \
--data-urlencode 'redirect_url=The redirect_url the user should be sent to after the onboarding process is complete. The number_id will be included as a POST parameter along with the invite_code.'

Response Example

200 - Example 1

{
    "status": "Success",
    "data": {
        "invite_url": "https://onboarding.softservv.co/?invite=123456",
        "company_name": "string",
        "plan_guid": "string",
        "redirect_url": "string",
        "setup_complete": "string",
        "date_created": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2025-09-08 13:47:58

Generate Embed Token