Skip to content

Creating a new Account Invitation

Request

Adds a user to your account.

Any members added in excess of your contracted license count are billed at a prorated subscription fee for the remainder of the billing term. To review your contracted license count, in Kantata OX, hover over Settings in the left navigation and select Plan.

This endpoint has its own rate limit. See the Knowledge Base for more information.

Bulk Create

This endpoint supports bulk creating up to 50 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:

{
  "account_invitations": [
    {
      "email_address": "email@email.com",
      "full_name": "Full Name"
    },
    {
      "email_address": "email@email.com",
      "full_name": "Full Name"
    }
  ]
}

This endpoint returns structured Account Invitation objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the account_invitations top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • default_role (Role) - The default role of the account.
  • invitee (User) - The new user who will receive the invitation.
  • inviter (User) - The user who has sent the invitation.
Bodyapplication/jsonrequired
account_invitationobject
{
  "account_invitation": {
    "billability_target": 0,
    "bill_rate_in_cents": 0,
    "cost_rate_in_cents": 0,
    "default_read_only": true,
    "default_role_id": 0,
    "email_address": "string",
    "full_name": "string",
    "headline": "string",
    "permission": "string",
    "external_reference": {
      "service_name": "string",
      "service_model": "string",
      "service_model_ref": "string",
      "status": "string",
      "external_message": "string",
      "external_link": "string",
      "external_status": "string",
      "locked": true
    }
  }
}

Responses

Account Invitation has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
account_invitationsobject
usersobject
rolesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "account_invitations": {
    "property1": {
      "bill_rate_in_cents": 0,
      "billability_target": 0,
      "cost_rate_in_cents": 0,
      "default_role_id": "string",
      "email_address": "string",
      "expiration_date": "string",
      "full_name": "string",
      "headline": "string",
      "invitee_id": "string",
      "inviter_id": "string",
      "pending": true,
      "permission": "string"
    },
    "property2": {
      "bill_rate_in_cents": 0,
      "billability_target": 0,
      "cost_rate_in_cents": 0,
      "default_role_id": "string",
      "email_address": "string",
      "expiration_date": "string",
      "full_name": "string",
      "headline": "string",
      "invitee_id": "string",
      "inviter_id": "string",
      "pending": true,
      "permission": "string"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "roles": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}