Director

A business profile's directors.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

directors, err := client.Director(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(directors)
created, err := client.Director(nil).Create(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
updated, err := client.Director(nil).Update(map[string]any{"profile_id": 1, "directors": []any{}}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)
removed, err := client.Director(nil).Remove(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(removed)

Lua

Construct client as shown in the Lua setup, then call the operations:

local directors, err = client:Director():list({ profile_id = 1 })
local created, err = client:Director():create({ profile_id = 1 })
local updated, err = client:Director():update({ profile_id = 1, directors = {} })
local removed, err = client:Director():remove({ profile_id = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$directors = $client->Director()->list(["profile_id" => 1]);
$created = $client->Director()->create(["profile_id" => 1]);
$updated = $client->Director()->update(["profile_id" => 1, "directors" => []]);
$client->Director()->remove(["profile_id" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

directors = client.Director().list({"profile_id": 1})
created = client.Director().create({ "profile_id": 1 })
updated = client.Director().update({"profile_id": 1, "directors": []})
client.Director().remove({"profile_id": 1})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

directors = client.Director.list({ "profile_id" => 1 })
created = client.Director.create({ "profile_id" => 1 })
updated = client.Director.update({ "profile_id" => 1, "directors" => [] })
client.Director.remove({ "profile_id" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const directors = await client.Director().list({ profile_id: 1 })
const created = await client.Director().create({ profile_id: 1 })
const updated = await client.Director().update({ profile_id: 1, directors: [] })
await client.Director().remove({ profile_id: 1 })

Fields

create

POST /profiles/{profileId}/directors

Operation ID: profileDirectorCreate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Example request body:

[
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1982-05-20",
    "firstName": "John",
    "lastName": "Doe"
  },
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1981-12-07",
    "firstName": "Jane",
    "lastName": "Doe"
  }
]

Responses

200: List of all directors associated with the business profile

application/json

Example response:

[
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1982-05-20",
    "firstName": "John",
    "id": 10,
    "lastName": "Doe"
  },
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1981-12-07",
    "firstName": "Jane",
    "id": 11,
    "lastName": "Doe"
  }
]

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

list

GET /profiles/{profileId}/directors

Operation ID: profileDirectorList.

Authentication: bearer token (UserToken).

Parameters

Responses

200: List of director objects

application/json

Example response:

[
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1982-05-20",
    "firstName": "John",
    "id": 10,
    "lastName": "Doe"
  },
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1981-12-07",
    "firstName": "Jane",
    "id": 11,
    "lastName": "Doe"
  }
]

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

remove

DELETE /profiles/{profileId}/directors

Operation ID: profileDirectorsDelete.

Authentication: bearer token (UserToken).

Parameters

Responses

200: List of all directors deleted from the business profile

application/json

Example response:

[
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1982-05-20",
    "firstName": "John",
    "id": 14,
    "lastName": "Doe"
  },
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1981-12-07",
    "firstName": "Jane",
    "id": 15,
    "lastName": "Doe"
  }
]

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PUT /profiles/{profileId}/directors

Operation ID: profileDirectorUpdate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Example request body:

[
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1982-05-20",
    "firstName": "John",
    "lastName": "Doe"
  },
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1981-12-07",
    "firstName": "Jane",
    "lastName": "Doe"
  }
]

Responses

200: List of all directors associated with the business profile

application/json

Example response:

[
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1982-05-20",
    "firstName": "John",
    "id": 14,
    "lastName": "Doe"
  },
  {
    "countryOfResidenceIso3Code": "usa",
    "dateOfBirth": "1981-12-07",
    "firstName": "Jane",
    "id": 15,
    "lastName": "Doe"
  }
]

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.