Update director

PUT 
https://api.publicsquare.com/business/directors/:id

Update an existing business director in the Account.

Permissions

• business:write

Request

Path Parameters

id stringrequired

application/json

Bodyrequired

titlestringrequired
Job title
Possible values: non-empty and <= 100 characters
Example: CEO
first_namestringrequired
First name
Possible values: non-empty and <= 100 characters
Example: John
last_namestringrequired
Last name
Possible values: non-empty and <= 100 characters
Example: Smith
date_of_birthdate-timerequired
Date of birth
Example: 1980-11-15
country_of_residencestringrequired
2 character ISO country code
Possible values: non-empty and <= 2 characters
Example: US

Responses

200

OK

application/json

Schema

Schema

idstringnullable
Business director ID
Example: dir_9azmvTSrmsavsWEWKMJKgRTYT
account_idstringnullable
Account ID
Example: acc_B518niGwGYKzig6vtrRVZGGGV
created_atdate-timenullable
Date business director was created
Example: 2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date business director was modified
Example: 2024-06-30T01:02:29.212Z
titlestringrequired
Job title
Possible values: non-empty and <= 100 characters
Example: CEO
first_namestringrequired
First name
Possible values: non-empty and <= 100 characters
Example: John
last_namestringrequired
Last name
Possible values: non-empty and <= 100 characters
Example: Smith
date_of_birthdate-timerequired
Date of birth
Example: 1980-11-15
country_of_residencestringrequired
2 character ISO country code
Possible values: non-empty and <= 2 characters
Example: US

Example (auto)

{
  "id": "dir_9azmvTSrmsavsWEWKMJKgRTYT",
  "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
  "created_at": "2024-06-30T01:02:29.212Z",
  "modified_at": "2024-06-30T01:02:29.212Z",
  "title": "CEO",
  "first_name": "John",
  "last_name": "Smith",
  "date_of_birth": "1980-11-15",
  "country_of_residence": "US"
}

400

Bad Request

application/json

Schema

Schema

errors objectnullable
property name* string[]
Array [
string
]
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "errors": {},
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

Forbidden

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (auto)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyscopes: business:writedescription: Authorization by API Key inside request's X-API-KEY headerin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://api.publicsquare.com/business/directors/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-KEY", "<X-API-KEY>");
var content = new StringContent("{\n  \"title\": \"CEO\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Smith\",\n  \"date_of_birth\": \"1980-11-15\",\n  \"country_of_residence\": \"US\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.publicsquare.com

Auth

ApiKey

Parameters

id — pathrequired

Body required

{
  "title": "CEO",
  "first_name": "John",
  "last_name": "Smith",
  "date_of_birth": "1980-11-15",
  "country_of_residence": "US"
}

ResponseClear

Click the Send API Request button above and see the response here!