Add a person to the given account

post

https://bench.gobridgit.com/rp/api/v1/accounts/{accountId}/Persons

Permissions
HourlyProfile: Write
Person: Write
Private: Read
Finance: Read

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

int32

required

The Account ID

Body Params

Details for the person object and any associated custom field values. Note: the title must be one of the titles already defined on the account.

string | null

uniqueId

string | null

name

string

required

length between 1 and 250

type

string

enum

required

Allowed:

title

string | null

photoUrl

uri | null

employmentDates

object | null

Request object for representing employment dates on a person.

workDays

array of int32s

required

length ≥ 1

Defaults to 1,2,3,4,5

workDays*

Allowed:

fields

array of objects | null

fields

groupings

array of int64s | null

groupings

industryStartDate

date-time | null

titleEffectiveDate

date-time | null

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

400

Bad Request - Request has missing or invalid values

401

Unauthorized

403

Forbidden - User doesn't have permissions on this resource, or the account couldn't be found

409

Conflict - A person with the provided email already exists on the account

422

Unprocessable Entity - Validation failure

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success: Person model of the newly added person