Skip to main content

Update user with policy details

PUT 
/api/users/:userId/update-policy

Update user with policy details.

Request​

Path Parameters

    userId stringrequired

Header Parameters

    partnerId stringrequired

    Partner Id

    clientId stringrequired

    Client Id

    clientSecret stringrequired

    Client Secret

Body

required

    policyNumber stringrequired

    Policy Number

    startDate stringrequired

    [startDate] The start date of the policy. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ; eg: 2024-01-01T00:00:00.000Z

    endDate stringrequired

    [endDate] The end date of the policy. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ; eg: 2024-01-01T00:00:00.000Z

Responses​

The updated user object.

Schema

    id string

    Unique Id for the user

    firstName string

    User's first name

    lastName string

    User's last name

    email string

    User's email address

    phone string

    User's cell phone number

    address

    object

    Address

    addressLine1 string

    Street Address Line 1

    addressLine2 string

    Street Address Line 2

    city string

    City

    state string

    2 Letter State Code

    country string

    2 Letter Country Code

    zip string

    Zip

    tosAnswer string

    Possible values: [None, Accepted, Declined]

    User's answer to terms of service for sharing data with Partner. (Only valid for certain partners)

    partnerCode string

    A code generated for the user to share with Partner. (Only valid for certain partners)

    dateRegistered string

    Time at which user was registered on the system

    updated string

    Last updated timestamp

Loading...