/report-job/profile/

post

https://qa-b2b.selfdecode.com/service/b2b-integrations/report-job/profile/

Create a new profile and report job

For more details regarding report jobs, please refer to the API documentation.

Populate the profile_data field for the new profile.
In case you have an exisitng profile and want to create a report job for it, please refer to the /report-job/profile/{profile_id}/ endpoint.

Body Params

Mixin for all job serializers.
Should be used by report and ancestry job serializers.

Encapsulates the common functionality to handle profile creation/updating and
genome file handling.

pdf_file_name

string

length ≤ 255

Filename of returned pdf (if blank default used)

pdf_config

string

For example: {
    "white_labelled": true,
    "company_profile": {
        "company_name": "DemoCorp Ltd.",
        "logo": "https://dummyimage.com/200x200/000/fff&text=Company+Logo",
        "professional_name": "John Doe Consulting",
        "website": "https://www.democorp.com",
        "email": "[email protected]",
        "phone": "+1-555-0123-456",
        "address": "1234 Demo Street, Demo City, 56789"
    },
    "notes": "This is a test note.",
    "custom_page_title": "Notes for You",
    "client_name": "John Doe",
    "lang": "es",
    "icon_style": "emoji",
    "number_of_recommendations": 15
}

desired_status

string

enum

required

profile_upserted - Profile Upserted
file_processed - File Processed
report_generated - Report Generated
pdf_generated - Pdf Generated

Allowed:

file_url

uri

Publicly accessible URL of the genome file. Please provide a valid URL in this field if you have not used the upload-file endpoint to upload file previously. Otherwise, leave this field empty and provide file_id instead.

file_id

uuid

Please provide file_id returned from upload-file endpoint.

profile_data

object

required

report_id

uuid

Required if desired_status is set to report_generated or pdf_generated

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

201