Profile Update
curl --request POST \
--url https://platform.grorapid.com/api/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<first-name>",
"last_name": "<last-name>",
"phone": "<phone-number>",
"country_code": "<country-code>"
}
'{
"version": "v1",
"status": true,
"statusCode": 200,
"details": "OK",
"statusMessage": "success",
"response": {
"me": {
"data": {
"id": "<user-id>",
"first_name": "<first-name>",
"last_name": "<last-name>",
"email": "user@example.com",
"phone": null,
"onboarding": {
"pages": true,
"emails": true,
"recipes": true,
"homepage": true
},
"country_code": "<country-code>",
"email_verified": true,
"source": "<source>",
"source_path": "<source-path>",
"created_at": "<created-at>",
"brands": {
"data": [
{
"id": "<brand-id>",
"name": "<brand-name>",
"slug": "<brand-slug>",
"description": null,
"brand_url": "https://example-brand.grorapid.co",
"logo": {
"data": []
},
"favicon": {
"data": []
},
"onboarded": true,
"active": true
}
]
},
"role": {
"data": {
"id": "<role-id>",
"name": "<role-name>",
"display_name": "<role-display-name>",
"brand_id": "<brand-id>",
"description": "<role-description>",
"permissions": {
"data": [
{
"name": "<permission-name-1>",
"display_name": "<permission-display-name-1>",
"description": "",
"category": "<permission-category-1>",
"active": 1
},
{
"name": "<permission-name-2>",
"display_name": "<permission-display-name-2>",
"description": "",
"category": "<permission-category-2>",
"active": 1
}
]
}
}
},
"roles": {
"data": [
{
"id": "<role-id>",
"name": "<role-name>",
"display_name": "<role-display-name>",
"brand_id": "<brand-id>",
"description": "<role-description>",
"permissions": {
"data": [
{
"name": "<permission-name-1>",
"display_name": "<permission-display-name-1>",
"description": "",
"category": "<permission-category-1>",
"active": 1
}
]
}
}
]
},
"currentBrand": {
"data": {
"id": "<brand-id>",
"name": "<brand-name>",
"slug": "<brand-slug>",
"description": null,
"brand_url": "https://example-brand.grorapid.co",
"website": null,
"domain": null,
"domain_verified": false,
"timezone": "<timezone>",
"country_code": "<country-code>",
"country": null,
"address": null,
"state": null,
"city": null,
"zip_code": null,
"logo": {
"data": []
},
"favicon": {
"data": []
},
"onboarded": true,
"industry_code": "<industry-code>",
"site_code": null,
"site_code_verified": false,
"site_public": false,
"settings": {
"lists": {
"double_optin": false
},
"general": {
"gdpr": false,
"language": "<language>"
},
"branding": {
"forms": true,
"webpages": true,
"campaigns": true
},
"recaptcha": {
"forms": true,
"webpages": true
},
"configuration": {
"campaing_allowed_contact_cleaning": [
1,
2,
4
]
},
"email_tracking": {
"unsubscribe": true,
"open_tracking": true,
"click_tracking": true
}
},
"conf": {
"logo": "https://assets.example.com/portal-logo.svg",
"favicon": "https://assets.example.com/favicon.ico",
"platform_name": "<platform-name>"
},
"p_key": "<public-key>",
"pusers": [],
"meta": {
"social": {
"blog": "",
"email": "",
"medium": "",
"reddit": "",
"twitter": "",
"website": "",
"youtube": "",
"facebook": "",
"linkedin": "",
"snapchat": "",
"whatsapp": "",
"instagram": ""
}
},
"all_plans": [
{
"key": "<free-plan-key>",
"details": {
"name": "<free-plan-name>",
"description": "<free-plan-description>"
},
"amounts": {
"default": {
"currency": "USD",
"currency_symbol": "$",
"value": "0",
"frequency": "month",
"payment_link": "https://portal.example.com/billing"
},
"IN": {
"currency": "INR",
"currency_symbol": "Rs",
"value": "0",
"frequency": "month",
"payment_link": "https://portal.example.com/billing"
}
}
},
{
"key": "<pro-plan-key>",
"details": {
"name": "<pro-plan-name>",
"description": "<pro-plan-description>"
},
"amounts": {
"default": {
"currency": "USD",
"currency_symbol": "$",
"value": "679",
"frequency": "year",
"payment_link": "https://payments.example.com/checkout/pro-annual"
},
"IN": {
"currency": "INR",
"currency_symbol": "Rs",
"value": "37665",
"frequency": "year",
"payment_link": "https://payments.example.com/checkout/pro-annual-in"
}
}
}
],
"api_key": "<api-key>",
"owner": {
"first_name": "<owner-first-name>",
"last_name": "<owner-last-name>",
"email": "owner@example.com"
},
"active": true,
"homepage": {
"data": {
"id": "<homepage-id>",
"status": "active",
"template": false,
"delete_allowed": false,
"activated_at": "<activated-at>",
"type": {
"data": {
"name": "webpage"
}
},
"service": {
"data": {
"name": "<homepage-name>",
"description": null,
"excerpt": null,
"brand_url": "https://example-brand.grorapid.co",
"slug": "<homepage-slug>",
"form_present": true,
"status": "active",
"preview_link": "https://example-brand.grorapid.co/<homepage-slug>?preview=<preview-token>",
"live_link": "https://example-brand.grorapid.co/<homepage-slug>",
"preview_image": "https://assets.example.com/homepage.png",
"custom_head": null,
"custom_body": null,
"custom_footer": null,
"visits": 1,
"settings": {
"appearance": {
"font": {
"font-family": "<font-family>",
"font-weight": {
"bold": "600",
"thin": "300",
"regular": "400",
"semibold": "500"
}
},
"colors": {
"light": "#f5f9fe",
"primary": "#2f80ed",
"text_primary": "#333333",
"text_tertiary": "#B0B0B0",
"text_secondary": "#828282"
}
},
"properties": [],
"configuration": 21,
"access_configuration": []
},
"created_at": "<homepage-created-at>",
"updated_at": "<homepage-updated-at>"
}
},
"tags": {
"data": []
},
"media": {
"data": []
}
}
}
}
},
"subscription": {
"data": {
"id": "<subscription-id>",
"payment_vendor": "<payment-vendor>",
"subscription_type": "<subscription-type>",
"info": {
"details": {
"name": "<subscription-name>",
"description": "<subscription-description>"
},
"amounts": {
"default": {
"currency": "USD",
"currency_symbol": "$",
"value": "679",
"frequency": "year",
"payment_link": "https://payments.example.com/checkout/subscription-default"
},
"IN": {
"currency": "INR",
"currency_symbol": "Rs",
"value": "37665",
"frequency": "year",
"payment_link": "https://payments.example.com/checkout/subscription-in"
}
},
"usage_nav": {
"plan_name": "<usage-plan-name>",
"blocks": [
{
"name": "<usage-block-name-1>",
"max": 10000,
"value": 0,
"high": false,
"key": "<usage-block-key-1>"
},
{
"name": "<usage-block-name-2>",
"max": 10000,
"value": 1,
"high": false,
"key": "<usage-block-key-2>"
}
],
"cta": {
"text": "<cta-text>",
"link": "https://portal.example.com/upgrade",
"visible": false
}
},
"usage_main": {
"plan_name": "<usage-plan-name>",
"blocks": [
{
"name": "<usage-block-name-1>",
"max": 10000,
"value": 0,
"high": false,
"key": "<usage-block-key-1>"
},
{
"name": "<usage-block-name-3>",
"max": 100000,
"value": 0,
"high": false,
"key": "<usage-block-key-3>"
}
],
"cta": {
"text": "<cta-text>",
"link": "https://portal.example.com/upgrade",
"visible": false
}
}
},
"start_date": "",
"end_date": "",
"plan_dates": "<plan-dates>",
"subscription_url": null,
"created_at": "<subscription-created-at>",
"updated_at": "<subscription-updated-at>",
"meta": null
}
}
}
}
}
}Account and Registration
Profile Update
Update the current profile.
POST
/
api
/
me
Profile Update
curl --request POST \
--url https://platform.grorapid.com/api/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<first-name>",
"last_name": "<last-name>",
"phone": "<phone-number>",
"country_code": "<country-code>"
}
'{
"version": "v1",
"status": true,
"statusCode": 200,
"details": "OK",
"statusMessage": "success",
"response": {
"me": {
"data": {
"id": "<user-id>",
"first_name": "<first-name>",
"last_name": "<last-name>",
"email": "user@example.com",
"phone": null,
"onboarding": {
"pages": true,
"emails": true,
"recipes": true,
"homepage": true
},
"country_code": "<country-code>",
"email_verified": true,
"source": "<source>",
"source_path": "<source-path>",
"created_at": "<created-at>",
"brands": {
"data": [
{
"id": "<brand-id>",
"name": "<brand-name>",
"slug": "<brand-slug>",
"description": null,
"brand_url": "https://example-brand.grorapid.co",
"logo": {
"data": []
},
"favicon": {
"data": []
},
"onboarded": true,
"active": true
}
]
},
"role": {
"data": {
"id": "<role-id>",
"name": "<role-name>",
"display_name": "<role-display-name>",
"brand_id": "<brand-id>",
"description": "<role-description>",
"permissions": {
"data": [
{
"name": "<permission-name-1>",
"display_name": "<permission-display-name-1>",
"description": "",
"category": "<permission-category-1>",
"active": 1
},
{
"name": "<permission-name-2>",
"display_name": "<permission-display-name-2>",
"description": "",
"category": "<permission-category-2>",
"active": 1
}
]
}
}
},
"roles": {
"data": [
{
"id": "<role-id>",
"name": "<role-name>",
"display_name": "<role-display-name>",
"brand_id": "<brand-id>",
"description": "<role-description>",
"permissions": {
"data": [
{
"name": "<permission-name-1>",
"display_name": "<permission-display-name-1>",
"description": "",
"category": "<permission-category-1>",
"active": 1
}
]
}
}
]
},
"currentBrand": {
"data": {
"id": "<brand-id>",
"name": "<brand-name>",
"slug": "<brand-slug>",
"description": null,
"brand_url": "https://example-brand.grorapid.co",
"website": null,
"domain": null,
"domain_verified": false,
"timezone": "<timezone>",
"country_code": "<country-code>",
"country": null,
"address": null,
"state": null,
"city": null,
"zip_code": null,
"logo": {
"data": []
},
"favicon": {
"data": []
},
"onboarded": true,
"industry_code": "<industry-code>",
"site_code": null,
"site_code_verified": false,
"site_public": false,
"settings": {
"lists": {
"double_optin": false
},
"general": {
"gdpr": false,
"language": "<language>"
},
"branding": {
"forms": true,
"webpages": true,
"campaigns": true
},
"recaptcha": {
"forms": true,
"webpages": true
},
"configuration": {
"campaing_allowed_contact_cleaning": [
1,
2,
4
]
},
"email_tracking": {
"unsubscribe": true,
"open_tracking": true,
"click_tracking": true
}
},
"conf": {
"logo": "https://assets.example.com/portal-logo.svg",
"favicon": "https://assets.example.com/favicon.ico",
"platform_name": "<platform-name>"
},
"p_key": "<public-key>",
"pusers": [],
"meta": {
"social": {
"blog": "",
"email": "",
"medium": "",
"reddit": "",
"twitter": "",
"website": "",
"youtube": "",
"facebook": "",
"linkedin": "",
"snapchat": "",
"whatsapp": "",
"instagram": ""
}
},
"all_plans": [
{
"key": "<free-plan-key>",
"details": {
"name": "<free-plan-name>",
"description": "<free-plan-description>"
},
"amounts": {
"default": {
"currency": "USD",
"currency_symbol": "$",
"value": "0",
"frequency": "month",
"payment_link": "https://portal.example.com/billing"
},
"IN": {
"currency": "INR",
"currency_symbol": "Rs",
"value": "0",
"frequency": "month",
"payment_link": "https://portal.example.com/billing"
}
}
},
{
"key": "<pro-plan-key>",
"details": {
"name": "<pro-plan-name>",
"description": "<pro-plan-description>"
},
"amounts": {
"default": {
"currency": "USD",
"currency_symbol": "$",
"value": "679",
"frequency": "year",
"payment_link": "https://payments.example.com/checkout/pro-annual"
},
"IN": {
"currency": "INR",
"currency_symbol": "Rs",
"value": "37665",
"frequency": "year",
"payment_link": "https://payments.example.com/checkout/pro-annual-in"
}
}
}
],
"api_key": "<api-key>",
"owner": {
"first_name": "<owner-first-name>",
"last_name": "<owner-last-name>",
"email": "owner@example.com"
},
"active": true,
"homepage": {
"data": {
"id": "<homepage-id>",
"status": "active",
"template": false,
"delete_allowed": false,
"activated_at": "<activated-at>",
"type": {
"data": {
"name": "webpage"
}
},
"service": {
"data": {
"name": "<homepage-name>",
"description": null,
"excerpt": null,
"brand_url": "https://example-brand.grorapid.co",
"slug": "<homepage-slug>",
"form_present": true,
"status": "active",
"preview_link": "https://example-brand.grorapid.co/<homepage-slug>?preview=<preview-token>",
"live_link": "https://example-brand.grorapid.co/<homepage-slug>",
"preview_image": "https://assets.example.com/homepage.png",
"custom_head": null,
"custom_body": null,
"custom_footer": null,
"visits": 1,
"settings": {
"appearance": {
"font": {
"font-family": "<font-family>",
"font-weight": {
"bold": "600",
"thin": "300",
"regular": "400",
"semibold": "500"
}
},
"colors": {
"light": "#f5f9fe",
"primary": "#2f80ed",
"text_primary": "#333333",
"text_tertiary": "#B0B0B0",
"text_secondary": "#828282"
}
},
"properties": [],
"configuration": 21,
"access_configuration": []
},
"created_at": "<homepage-created-at>",
"updated_at": "<homepage-updated-at>"
}
},
"tags": {
"data": []
},
"media": {
"data": []
}
}
}
}
},
"subscription": {
"data": {
"id": "<subscription-id>",
"payment_vendor": "<payment-vendor>",
"subscription_type": "<subscription-type>",
"info": {
"details": {
"name": "<subscription-name>",
"description": "<subscription-description>"
},
"amounts": {
"default": {
"currency": "USD",
"currency_symbol": "$",
"value": "679",
"frequency": "year",
"payment_link": "https://payments.example.com/checkout/subscription-default"
},
"IN": {
"currency": "INR",
"currency_symbol": "Rs",
"value": "37665",
"frequency": "year",
"payment_link": "https://payments.example.com/checkout/subscription-in"
}
},
"usage_nav": {
"plan_name": "<usage-plan-name>",
"blocks": [
{
"name": "<usage-block-name-1>",
"max": 10000,
"value": 0,
"high": false,
"key": "<usage-block-key-1>"
},
{
"name": "<usage-block-name-2>",
"max": 10000,
"value": 1,
"high": false,
"key": "<usage-block-key-2>"
}
],
"cta": {
"text": "<cta-text>",
"link": "https://portal.example.com/upgrade",
"visible": false
}
},
"usage_main": {
"plan_name": "<usage-plan-name>",
"blocks": [
{
"name": "<usage-block-name-1>",
"max": 10000,
"value": 0,
"high": false,
"key": "<usage-block-key-1>"
},
{
"name": "<usage-block-name-3>",
"max": 100000,
"value": 0,
"high": false,
"key": "<usage-block-key-3>"
}
],
"cta": {
"text": "<cta-text>",
"link": "https://portal.example.com/upgrade",
"visible": false
}
}
},
"start_date": "",
"end_date": "",
"plan_dates": "<plan-dates>",
"subscription_url": null,
"created_at": "<subscription-created-at>",
"updated_at": "<subscription-updated-at>",
"meta": null
}
}
}
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
200 - application/json
Updated profile.
The response is of type object.
⌘I
