Skip to main content
PATCH
/
organizations
/
v2
/
bo
/
audit
/
{organizationId}
Update an organization
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/organizations/v2/bo/audit/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "name": "Organization Name",
  "comment": "Comment",
  "language": 1,
  "timezone": "Europe/Paris",
  "engagementDuration": 12,
  "engagementStartAt": "2024-01-01T12:34:56.000Z",
  "uploadSizeLimit": 5120,
  "accessStatus": 2,
  "onboardingStatus": 2,
  "address": {
    "streetAddress": "123 Main St",
    "country": "USA",
    "postalCode": "10001",
    "city": "New York"
  }
}
'
{
  "data": {
    "id": 1,
    "type": 2,
    "name": "Organization Name",
    "comment": "Comment",
    "uploadSizeLimit": 5120,
    "uploadSizeUsed": 0,
    "language": 1,
    "timezone": "Europe/Paris",
    "engagementDuration": 12,
    "engagementEndAt": "2024-12-01T12:34:56.000Z",
    "engagementStartAt": "2024-01-01T12:34:56.000Z",
    "renewAt": "2025-01-01T12:34:56.000Z",
    "onboardingStatus": 2,
    "onboardingUpdatedAt": "2024-12-01T12:34:56.000Z",
    "accessStatus": 2,
    "accessStatusUpdatedAt": "2024-12-01T12:34:56.000Z",
    "createdByUserId": 1,
    "contractType": 1,
    "address": "123 Main St, City, Country",
    "settings": {
      "anomalyRiskFormat": "letter"
    },
    "archivedAt": "2024-12-01T12:34:56.000Z",
    "deletedAt": "2024-12-01T12:34:56.000Z",
    "updatedAt": "2024-12-01T12:34:56.000Z",
    "createdAt": "2024-12-01T12:34:56.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to update an organization

​
name
string

Name of the organization.

Maximum string length: 100
Example:

"Organization Name"

​
comment
string

Comment about the organization.

Maximum string length: 1000
Example:

"Comment"

​
language
enum<number>

Language of the organization.

Available options:
1,
2,
3
Example:

1

​
timezone
string

Timezone of the organization.

Maximum string length: 100
Example:

"Europe/Paris"

​
engagementDuration
integer

Duration of the commitment in months.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

12

​
engagementStartAt

Start date of the commitment.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-01-01T12:34:56.000Z"

​
uploadSizeLimit
integer

Upload size limit in Mo (default 5Go).

Required range: 0 <= x <= 9007199254740991
Example:

5120

​
accessStatus
enum<number>

Access status of the organization (noAccess = 1, access = 2).

Available options:
1,
2
Example:

2

​
onboardingStatus
enum<number>

Onboarding status of the organization (notStarted, inProgress, completed).

Available options:
1,
2,
3,
4,
5,
6
Example:

2

​
address
object

Response

200 - application/json

The organization have been updated

​
data
object
required