Create a profile share

Gateway module

POST/profile-sharesprofileShares.create

A consent snapshot of profile fields shared with one org. Live updates stop on revoke after close. Creates a profile share. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability me.profile.write.
OAuth scopes: me.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ProfileShareCreate

profileShares.create: ProfileShareCreate
Field	Type	Required	Description
organization_id	string (uuid) \| null	No	Identifier of the external account sharing its company profile; null when a person shares their own.
shared_fields	array of object	Yes	Each shared field with the value at the time of sharing.
engagement_id	string (uuid) \| null	No	Identifier of the engagement the share serves; live updates flow only while it is open.

{
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shared_fields": [
    {
      "field_key": "headline",
      "field_value": "Head Rigger"
    }
  ],
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: ProfileShare

profileShares.create: ProfileShare
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the profile share.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
person_id	string (uuid) \| null	Yes	Identifier of the sharing person.
organization_id	string (uuid) \| null	Yes	Identifier of the external account sharing its company profile; null when a person shares their own.
shared_fields	array of object	Yes	Each shared field with the value at the time of sharing.
shared_at	string (date-time)	Yes	When the snapshot was taken.
revoked_at	string (date-time) \| null	Yes	When consent was revoked.
engagement_id	string (uuid) \| null	Yes	Identifier of the engagement the share serves; live updates flow only while it is open.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shared_fields": [
    {
      "field_key": "headline",
      "field_value": "Head Rigger"
    }
  ],
  "shared_at": "2026-10-08T14:30:00Z",
  "revoked_at": "2026-10-08T14:30:00Z",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/profile-shares" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","shared_fields":[{"field_key":"headline","field_value":"Head Rigger"}],"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.profileShares.create({
    "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "shared_fields": [
      {
        "field_key": "headline",
        "field_value": "Head Rigger"
      }
    ],
    "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.profile_shares.create({"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "shared_fields": [{"field_key": "headline", "field_value": "Head Rigger"}], "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos profile-shares create --data '{"organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","shared_fields":[{"field_key":"headline","field_value":"Head Rigger"}],"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'