Company Data

Create company data

post

Adds or updates specific data associated with a company, such as social links, descriptions, icons, and highlights.

Body

application/json

company_idintegerRequired

The ID of the company to update data for.

Example: 385

keystringRequired

The key representing the type of data, such as 'linkedin', 'facebook', or 'phone'.

Example: linkedin

valuestringRequired

The value associated with the key, such as a username, URL, or other data.

Example: phillip.musiime

titlestringOptional

An optional title for the data.

Example: LinkedIn Profile

descriptionstringOptional

An optional description for the data.

Example: Phillip Musiime's LinkedIn Profile

highlightinteger · enumOptional

Flag to highlight this data on the company's profile.

Example: 1Possible values:

icon_urlstringOptional

URL for the icon to be displayed alongside the data.

Example: https://example.com/icons/linkedin.png

Responses

200

Company data updated successfully

application/json

post

/company/data

HTTPcURLJavaScriptPython

POST /company/data HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "company_id": 385,
  "key": "linkedin",
  "value": "phillip.musiime",
  "title": "LinkedIn Profile",
  "description": "Phillip Musiime's LinkedIn Profile",
  "highlight": 1,
  "icon_url": "https://example.com/icons/linkedin.png"
}

200

Company data updated successfully

{
  "status": "success",
  "company": {
    "id": 12345,
    "user_id": 67890,
    "path": "example-company",
    "name": "Example Company",
    "description": "This is an example company description.",
    "image_profile": "https://some-domain/images/profile.png",
    "image_banner": "https://some-domain/images/banner.png",
    "background": "#ffffff",
    "icons": "#000000",
    "text": "#333333",
    "font": "https://some-domain/fonts/some-font.ttf",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 0,
    "plan_required": 1,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "pay_via_invoice": 0,
    "pay_via_invoice_ppu": 0.01,
    "pay_via_invoice_payday": 1,
    "verified": 0,
    "timestamp": 1624857600,
    "lead_data_consent_email_text": "Please provide consent to receive emails.",
    "lead_data_consent_required": 0,
    "language": "en",
    "uneditable_profile_fields": [
      "email",
      "username"
    ],
    "user_email_unchangeable": 1,
    "lead_opt_out_available": 0,
    "profiles_public": 0,
    "force_sso": 0,
    "signup_options": [
      "email_password"
    ],
    "lock_profiles": 0,
    "custom_url": "https://customurl.com",
    "lead_create_reminder_days": 15,
    "lead_create_reminder_type": "email",
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "only_show_own_lead": 0
  }
}

Update company data

put

Updates specific fields of a company data entry.

Body

application/json

company_idintegerRequired

The ID of the company to update the data for.

Example: 385

data_idintegerRequired

The ID of the company data entry to update.

Example: 13799

valuestringOptional

The updated value for the data entry.

Example: Updated Value

titlestringOptional

The updated title for the data entry.

Example: Updated Title

descriptionstringOptional

The updated description for the data entry.

Example: Updated description.

highlightinteger · enumOptional

Flag to highlight the data entry.

Example: 1Possible values:

activeinteger · enumOptional

Flag to indicate if the data entry is active.

Example: 1Possible values:

icon_urlstringOptional

The URL or path to the icon associated with the data entry.

Example: https://example.com/icon.png

Responses

200

Success

application/json

put

/company/data

HTTPcURLJavaScriptPython

PUT /company/data HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "company_id": 385,
  "data_id": 13799,
  "value": "Updated Value",
  "title": "Updated Title",
  "description": "Updated description.",
  "highlight": 1,
  "active": 1,
  "icon_url": "https://example.com/icon.png"
}

200

Success

{
  "status": "success",
  "company": {
    "id": 12345,
    "user_id": 67890,
    "path": "example-company",
    "name": "Example Company",
    "description": "This is an example company description.",
    "image_profile": "https://some-domain/images/profile.png",
    "image_banner": "https://some-domain/images/banner.png",
    "background": "#ffffff",
    "icons": "#000000",
    "text": "#333333",
    "font": "https://some-domain/fonts/some-font.ttf",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 0,
    "plan_required": 1,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "pay_via_invoice": 0,
    "pay_via_invoice_ppu": 0.01,
    "pay_via_invoice_payday": 1,
    "verified": 0,
    "timestamp": 1624857600,
    "lead_data_consent_email_text": "Please provide consent to receive emails.",
    "lead_data_consent_required": 0,
    "language": "en",
    "uneditable_profile_fields": [
      "email",
      "username"
    ],
    "user_email_unchangeable": 1,
    "lead_opt_out_available": 0,
    "profiles_public": 0,
    "force_sso": 0,
    "signup_options": [
      "email_password"
    ],
    "lock_profiles": 0,
    "custom_url": "https://customurl.com",
    "lead_create_reminder_days": 15,
    "lead_create_reminder_type": "email",
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "only_show_own_lead": 0
  }
}

Delete a company data entry

delete

Deletes a specific data entry for a company.

Body

application/json

company_idintegerRequired

The ID of the company to delete the data from.

Example: 385

data_idintegerRequired

The ID of the company data entry to delete.

Example: 13799

Responses

200

Success

application/json

delete

/company/data

HTTPcURLJavaScriptPython

DELETE /company/data HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "company_id": 385,
  "data_id": 13799
}

200

Success

{
  "status": "success",
  "company": {
    "id": 12345,
    "user_id": 67890,
    "path": "example-company",
    "name": "Example Company",
    "description": "This is an example company description.",
    "image_profile": "https://some-domain/images/profile.png",
    "image_banner": "https://some-domain/images/banner.png",
    "background": "#ffffff",
    "icons": "#000000",
    "text": "#333333",
    "font": "https://some-domain/fonts/some-font.ttf",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 0,
    "plan_required": 1,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "pay_via_invoice": 0,
    "pay_via_invoice_ppu": 0.01,
    "pay_via_invoice_payday": 1,
    "verified": 0,
    "timestamp": 1624857600,
    "lead_data_consent_email_text": "Please provide consent to receive emails.",
    "lead_data_consent_required": 0,
    "language": "en",
    "uneditable_profile_fields": [
      "email",
      "username"
    ],
    "user_email_unchangeable": 1,
    "lead_opt_out_available": 0,
    "profiles_public": 0,
    "force_sso": 0,
    "signup_options": [
      "email_password"
    ],
    "lock_profiles": 0,
    "custom_url": "https://customurl.com",
    "lead_create_reminder_days": 15,
    "lead_create_reminder_type": "email",
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "only_show_own_lead": 0
  }
}

Update the order of company data

put

Updates the order of the data fields for a company.

Body

application/json

company_idintegerRequired

The ID of the company.

Example: 385

orderinteger[]Required

An array representing the new order of data item IDs.

Example: 13799

Responses

200

Order update success response

application/json

put

/company/data/order

HTTPcURLJavaScriptPython

PUT /company/data/order HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "company_id": 385,
  "order": [
    13799
  ]
}

200

Order update success response

{
  "status": "success",
  "company": {
    "id": 12345,
    "user_id": 67890,
    "path": "example-company",
    "name": "Example Company",
    "description": "This is an example company description.",
    "image_profile": "https://some-domain/images/profile.png",
    "image_banner": "https://some-domain/images/banner.png",
    "background": "#ffffff",
    "icons": "#000000",
    "text": "#333333",
    "font": "https://some-domain/fonts/some-font.ttf",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 0,
    "plan_required": 1,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "pay_via_invoice": 0,
    "pay_via_invoice_ppu": 0.01,
    "pay_via_invoice_payday": 1,
    "verified": 0,
    "timestamp": 1624857600,
    "lead_data_consent_email_text": "Please provide consent to receive emails.",
    "lead_data_consent_required": 0,
    "language": "en",
    "uneditable_profile_fields": [
      "email",
      "username"
    ],
    "user_email_unchangeable": 1,
    "lead_opt_out_available": 0,
    "profiles_public": 0,
    "force_sso": 0,
    "signup_options": [
      "email_password"
    ],
    "lock_profiles": 0,
    "custom_url": "https://customurl.com",
    "lead_create_reminder_days": 15,
    "lead_create_reminder_type": "email",
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "only_show_own_lead": 0
  }
}