Function createTrackingIdentity

createTrackingIdentity<ThrowOnError extends boolean = true>(
    options: Options<CreateTrackingIdentityData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                email: string;
                status: string;
                statusAt: string;
                trackingId: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                customer: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Create tracking identity Identifies a user.

The following role is required for this endpoint: org.tracking
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<CreateTrackingIdentityData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                email: string;
                status: string;
                statusAt: string;
                trackingId: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                customer: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:3738

Function createTrackingIdentity

Type Parameters

Parameters

Settings