Update a connected organization

Request

Security

form_session or user_session or component_session or component_token or api_token

Path

uidstring(ConnectedOrganizationId)required

Connected Organization Identifier

Bodyapplication/jsonrequired

namestring

dba_namestring or null

Any of:

string

einstring or null

Any of:

string

business_emailstring

candidate_support_emailstring or null

Any of:

string

phonestring or null

Any of:

string

default_languagestring

Enum:"af""ak""sq""am""ar""hy""as""ay""az""bm"

supported_languagesArray of strings

Items Enum:"af""ak""sq""am""ar""hy""as""ay""az""bm"

addressobject or null

Any of:

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/connected_organizations/{uid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "dba_name": "string",
    "ein": "string",
    "business_email": "string",
    "candidate_support_email": "string",
    "phone": "string",
    "default_language": "af",
    "supported_languages": [
      "af"
    ],
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "AND",
      "full_address": "string"
    }
  }'

Responses

ConnectedOrganization

Bodyapplication/json

idstringrequired

namestringrequired

dba_namestring or nullrequired

Any of:

string

einstring or nullrequired

Any of:

string

business_emailstring or nullrequired

Any of:

string

candidate_support_emailstring or nullrequired

Any of:

string

phonestring or nullrequired

Any of:

string

live_account_idstringrequired

test_account_idstringrequired

default_languagestring or nullrequired

Any of:

string

Enum:"af""ak""sq""am""ar""hy""as""ay""az""bm"

supported_languagesArray of strings or nullrequired

Any of:

Array of strings

addressobject or nullrequired

Any of:

trial_end_atstring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

Response

{
  "id": "string",
  "name": "string",
  "dba_name": "string",
  "ein": "string",
  "business_email": "string",
  "candidate_support_email": "string",
  "phone": "string",
  "live_account_id": "string",
  "test_account_id": "string",
  "default_language": "af",
  "supported_languages": [
    "af"
  ],
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "AND",
    "full_address": "string"
  },
  "trial_end_at": "string",
  "created_at": "string",
  "updated_at": "string"
}