(v3) Create or Update Profile Data

post

https://{amsServer}/{amsAppName}/api/v3/forms/profile/{formId}/data

Creates or updates a profile record for a user. REST alternative to POST /api/v1/profileimport.

Important: Importing data to a profile form that already has data will overwrite the existing record. There is no merge.

Note: Schema details are best-effort — confirm field names using GET /api/v3/forms/{form_type}/{form_id} before building.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

formId

integer

required

The profile form ID

Query Params

string

enum

Pass as=api_user when authenticating as an API user account (one created via Integrations Manager) that does not have explicit profile form permissions. Omitting this param causes the request to be treated as a normal user and may result in a permission error.

Allowed:

Body Params

@type

string

enum

required

Jackson type discriminator required by the API. Must be the literal string "Profile".

Allowed:

formId

string

required

The profile form ID (same value as the formId path parameter, passed as a string).

applicationId

string

The numeric application ID for the AMS instance. Obtain from the (v2) Authenticate User response (applicationId field).

userId

string

required

The ID of the user whose profile record to create or update. Passed as a string.

changed

boolean

Set to true to mark the record as changed.

rows

object

required

Map of row index (as a string key) to an object of field key/value pairs. Profile forms typically have one row ("0").

Headers

session-header

string

required

The current session token. Returned by most API calls and must be passed on all subsequent v2/v3 calls.

X-APP-ID

string

A unique identifier for your application. Helps Teamworks support staff identify your requests if you need assistance.

Responses

200

Profile record created or updated successfully

404The specified profile form was not found.