Update profile data

patch

https://example.com/v1/profile/{publicId}

Use this when partially updating profile answer data for a company. Omit publicId to update the calling entity's own profile.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

publicId

string

required

PublicID of profile to update. Omit to update your own profile.

Query Params

connectionRole

string

enum

Role of the user updating the connection - optional

Allowed:

locale

string

Language locale of the user updating the profile

slimResponse

boolean

Only return the connection portion of the response. Don't return the answers.

updateChangeDateForInterface

boolean

Set to false to cause the profile change to not update interface change dates. This will prevent the change from causing the connection to show up on the change list.

strictValidation

boolean

Opt into canonical answer-format and eligibility preflight with true. False skips this preflight only; permissions, kit access and row-deletion authorization always apply. Omission currently preserves legacy behavior; the server may later default to strict validation, with false remaining an explicit opt-out. This is not a dry run: accepted requests still write data.

Body Params

JSON document of answer key/values

Map of exact answer keys to write values. Values may be scalars, arrays, objects, or null where the question supports clearing. Question-specific types, permissions, and constraints still apply. GET representations are not necessarily valid write values. For a file upload use {fileName, fileContentsBase64} with raw padded base64. For an existing repeating-group row include its id; omitting id creates a new row.

Responses

403

Service-account save-time permission failures reject before uploads. Row-deletion permission failures reject before uploads for all credentials, including in observe mode. Public enforce-mode preflight can return 400 earlier for invalid, inaccessible or unsupported fields. Observe mode otherwise retains legacy field-skipping behavior; it does not disable write-time permissions.

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200JSON document of updated company data. Document properties are answer keys.