Profile

Get Profile

get

Query parameters

company_idintegerOptional

The ID of the company to which the profile belongs

profile_idintegerOptional

The ID of the profile to retrieve

pathstringOptional

The path associated with the profile

Responses

200

Successful retrieval of the profile.

application/json

get

/profile

HTTPcURLJavaScriptPython

GET /profile HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful retrieval of the profile.

{
  "status": "success",
  "profile": {
    "id": 22300,
    "user_id": 21312,
    "company_id": 385,
    "path": "path320125",
    "name": "Allene Larson",
    "job": "Dancer",
    "company": "Zulauf-Emmerich",
    "description": "Incidunt placeat dolorem in aut ut est harum praesentium.",
    "image_profile": "https://picsum.photos/200",
    "image_company": "https://picsum.photos/200",
    "image_banner": "https://picsum.photos/600/300",
    "background": "#12582c",
    "text": "",
    "icons": "",
    "font": "",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 1,
    "locked": 1,
    "created_by": "azure",
    "verified": 0,
    "timestamp": 1702555178,
    "language": null,
    "active": 1,
    "primary": 1,
    "department": null,
    "user_email": "[email protected]"
  }
}

Create a Profile

post

Body

application/json

namestringOptional

The name of the profile

jobstringOptional

The job title associated with the profile

companystringRequired

The company name associated with the profile

descriptionstringOptional

A brief description of the profile

image_profilestringOptional

URL to the profile image

image_companystringOptional

URL to the company image

image_bannerstringOptional

URL to the banner image

backgroundstringOptional

Background information for the profile

textstringOptional

Text content associated with the profile

amountintegerOptional

The number of profiles to create

Default: 1

Responses

200

Successful creation of the profile.

application/json

post

/profile

HTTPcURLJavaScriptPython

POST /profile HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "name": "text",
  "job": "text",
  "company": "text",
  "description": "text",
  "image_profile": "text",
  "image_company": "text",
  "image_banner": "text",
  "background": "text",
  "text": "text",
  "amount": 1
}

200

Successful creation of the profile.

{
  "id": 22300,
  "user_id": 21312,
  "company_id": 385,
  "path": "path320125",
  "name": "Allene Larson",
  "job": "Dancer",
  "company": "Zulauf-Emmerich",
  "description": "Incidunt placeat dolorem in aut ut est harum praesentium.",
  "image_profile": "https://picsum.photos/200",
  "image_company": "https://picsum.photos/200",
  "image_banner": "https://picsum.photos/600/300",
  "background": "#12582c",
  "text": "",
  "icons": "",
  "font": "",
  "lead_form_setting": 1,
  "lead_form_custom": 0,
  "disable_lead_form": 0,
  "instant_lead_form_on": 1,
  "locked": 1,
  "created_by": "azure",
  "verified": 0,
  "timestamp": 1702555178,
  "language": null,
  "active": 1,
  "primary": 1,
  "department": null,
  "user_email": "[email protected]"
}

Update Profile

put

Body

application/json

anyOptional

or

anyOptional

Responses

200

Successfully updated the profile.

application/json

put

/profile

HTTPcURLJavaScriptPython

PUT /profile HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 409

{
  "profile_id": 1,
  "profile_ids": [
    1
  ],
  "company_id": 1,
  "name": "text",
  "job": "text",
  "company": "text",
  "image_profile": "text",
  "image_company": "text",
  "image_banner": "text",
  "font": "text",
  "locked": true,
  "language": "text",
  "qr_logo": "text",
  "qr_style": "text",
  "qr_color": "text",
  "virtual_background": "text",
  "path": "text",
  "description": "text",
  "text": "text",
  "icons": "text",
  "background": "text",
  "lead_form_setting": 1,
  "primary": true
}

200

Successfully updated the profile.

{
  "status": "success",
  "profile": {
    "id": 22300,
    "user_id": 21312,
    "company_id": 385,
    "path": "path320125",
    "name": "Allene Larson",
    "job": "Dancer",
    "company": "Zulauf-Emmerich",
    "description": "Incidunt placeat dolorem in aut ut est harum praesentium.",
    "image_profile": "https://picsum.photos/200",
    "image_company": "https://picsum.photos/200",
    "image_banner": "https://picsum.photos/600/300",
    "background": "#12582c",
    "text": "",
    "icons": "",
    "font": "",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 1,
    "locked": 1,
    "created_by": "azure",
    "verified": 0,
    "timestamp": 1702555178,
    "language": null,
    "active": 1,
    "primary": 1,
    "department": null,
    "user_email": "[email protected]"
  }
}

Delete Profile

delete

Body

application/json

profile_idintegerRequired

The ID of the profile to delete

Responses

200

Successfully deleted the profile.

application/json

delete

/profile

HTTPcURLJavaScriptPython

DELETE /profile HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "profile_id": 1
}

200

Successfully deleted the profile.

{
  "status": "success"
}

Create Multiple Profiles

post

Body

application/json

company_idintegerRequired

The ID of the company for which profiles are being created

filestring · binaryOptional

A file containing profile data (optional)

countintegerOptional

Number of profiles to create (optional)

emailsstring · email[]Optional

An array of email addresses to create profiles for (optional)

send_walletbooleanOptional

Whether to send wallet links to the created profiles

Default: false

new_profilesobjectOptional

Details for the new profiles if creating multiple profiles with a count

Responses

200

Successful creation of the profiles.

application/json

post

/profiles

HTTPcURLJavaScriptPython

POST /profiles HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "company_id": 1,
  "file": "binary",
  "count": 1,
  "emails": [
    "[email protected]"
  ],
  "send_wallet": false,
  "new_profiles": {}
}

200

Successful creation of the profiles.

{
  "status": "success"
}

Update Profile Name and Company

get

Query parameters

profile_idintegerRequired

The ID of the profile to update

namestringRequired

The new name for the profile

emailstring · emailRequired

The email associated with the profile

company_namestringRequired

The new company name for the profile

Responses

200

Successfully updated the profile.

application/json

get

/profile/edit

HTTPcURLJavaScriptPython

GET /profile/edit?profile_id=1&name=text&email=name%40gmail.com&company_name=text HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successfully updated the profile.

{
  "status": "success",
  "profile": {
    "id": 22300,
    "user_id": 21312,
    "company_id": 385,
    "path": "path320125",
    "name": "Allene Larson",
    "job": "Dancer",
    "company": "Zulauf-Emmerich",
    "description": "Incidunt placeat dolorem in aut ut est harum praesentium.",
    "image_profile": "https://picsum.photos/200",
    "image_company": "https://picsum.photos/200",
    "image_banner": "https://picsum.photos/600/300",
    "background": "#12582c",
    "text": "",
    "icons": "",
    "font": "",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 1,
    "locked": 1,
    "created_by": "azure",
    "verified": 0,
    "timestamp": 1702555178,
    "language": null,
    "active": 1,
    "primary": 1,
    "department": null,
    "user_email": "[email protected]"
  }
}