Skip to content
ApiqDevelopers
API v1.64.0Open console
API referenceidentity

Update activation profile

PATCH/v1/activation/profile
Idempotency-Key requiredAccepts bearer

Tell us about the business — rail step 3

Partial update of the tenant's business profile: a member that is absent is unchanged.Show morePartial update of the tenant's business profile: a member that is absent is unchanged. Human session only (an API key is 403 PERMISSION_DENIED details.reason SESSION_REQUIRED); needs users:manage. Idempotency-Key required. Audited. buildingIntent may be set here after sign-up (the Welcome screen's question); it reads back as ActivationState.buildingIntent and changes no step. Once a GST registration is confirmed (ActivationState.registrationConfirmedAt set), a body naming a gstin or pan different from the confirmed one is 409 CONFLICT details.reason REGISTRATION_LOCKED (details.field names it) and nothing is changed: a confirmed registration changes only through POST /v1/activation/business-registration:confirm. Sending the confirmed values again is a no-op for them. the profile also takes businessStructure (the country's legal form label, a sole proprietorship being one of them), industry (with industryOther when it is OTHER), website or noWebsite true with productDescription (10 to 500 characters, required when noWebsite is true: 400 VALIDATION details.field productDescription otherwise), phone (E.164) and monthlyVolume (a band in a currency; the bands per currency are on MonthlyVolume). On the CAPPED flow step business_profile is done, and complete is true, when country, businessStructure, industry, website or noWebsite with productDescription, phone and monthlyVolume are set; businessType and volumeBand stay for the NINE_STEP rail and are not read on CAPPED. industryOther without industry OTHER, or website together with noWebsite true, is 400 VALIDATION with details.field naming the member. The website also sets the domain a work e-mail must be on (POST /v1/activation/work-email:send-code). With the capped flow off the new members are 400 VALIDATION details.field naming the member.

Headers

  • Idempotency-KeystringRequired
    Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 IDEMPOTENCY_CONFLICT; in-flight duplicate…Show moreMandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 IDEMPOTENCY_CONFLICT; in-flight duplicate is 409 IDEMPOTENCY_IN_PROGRESS.

Request body

  • businessTypestringOptional
    • TRAVEL_AGENCY
    • ONLINE_TRAVEL_AGENCY
    • TRAVEL_MANAGEMENT_COMPANY
    • TOUR_OPERATOR
    • SOFTWARE_PLATFORM
    • OTHER
  • countrystringOptional
    ISO 3166-1 alpha-2
  • websitestring · uriOptional
  • volumeBandstringOptional
    • UNDER_10K
    • FROM_10K_TO_100K
    • FROM_100K_TO_1M
    • OVER_1M
  • gstinstringOptional
    India GSTIN (15 characters); verified against the government source by the KYB provider
  • panstringOptional
    India PAN (10 characters)
  • buildingIntentstringOptional
    what the person is building — API_INTEGRATION (calling the API from their own code), AI_AGENT (an AI agent over MCP or the API), BOOKING_SITE (a booking site without code).Show morewhat the person is building — API_INTEGRATION (calling the API from their own code), AI_AGENT (an AI agent over MCP or the API), BOOKING_SITE (a booking site without code). A closed request enum here; the same values read back as the x-extensible-enum ActivationState.buildingIntent, which a client renders tolerantly.
    • API_INTEGRATION
    • AI_AGENT
    • BOOKING_SITE
  • businessStructurestringOptional
    the country's legal form label as the person picks it, for example "Private limited company", "Limited liability partnership", "Sole proprietorship", "Single-member LLC" or "Free zone establishment";…Show morethe country's legal form label as the person picks it, for example "Private limited company", "Limited liability partnership", "Sole proprietorship", "Single-member LLC" or "Free zone establishment"; required on CAPPED for business_profile
  • industrystringOptional
    what the business does; OTHER with industryOther
  • industryOtherstringOptional
    the industry in the person's words, with industry OTHER only
  • noWebsitebooleanOptional
    true when the business has no website; productDescription is then required and website must be absent
  • productDescriptionstringOptional
    what the business sells and to whom, in a sentence or two; required when noWebsite is true
  • phonestringOptional
    the business phone, E.164
  • monthlyVolumeMonthlyVolumeOptional
    the expected monthly booking value as a band in a currency (ISO 4217).Show morethe expected monthly booking value as a band in a currency (ISO 4217). The bands are per currency. INR BAND_1 under ₹5 lakh, BAND_2 ₹5 lakh to ₹25 lakh, BAND_3 ₹25 lakh to ₹1 crore, BAND_4 ₹1 crore to ₹5 crore, BAND_5 over ₹5 crore. GBP, USD and CAD BAND_1 under 5,000, BAND_2 5,000 to 25,000, BAND_3 25,000 to 100,000, BAND_4 100,000 to 500,000, BAND_5 over 500,000. AED BAND_1 under 25,000, BAND_2 25,000 to 100,000, BAND_3 100,000 to 500,000, BAND_4 500,000 to 2,500,000, BAND_5 over 2,500,000. Another currency reads the USD bands. NOT_SURE is a valid answer. band is x-extensible-enum.
    2 child attributes
    • bandstringRequired
    • currencystringRequired

Responses

  • 200The profile as storedBusinessProfile
  • 400VALIDATION or UNKNOWN_DOMAINApiErrorResponse
  • 401
    UNAUTHENTICATED — missing or expired token.Show moreUNAUTHENTICATED — missing or expired token. Declared on every operation because `security` is declared globally at the document root: every route is authenticated, so every route can answer 401.
    ApiErrorResponse
  • 403ApiErrorResponse
  • 405
    VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge).Show moreVALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge). Not retryable as sent.
    ApiErrorResponse
  • 409CONFLICT REGISTRATION_LOCKED — a gstin or pan different from the confirmed GST registration; or IDEMPOTENCY_CONFLICT | IDEMPOTENCY_IN_PROGRESSApiErrorResponse
  • 413
    VALIDATION — the request body is larger than the surface's limit.Show moreVALIDATION — the request body is larger than the surface's limit. Not retryable as sent: shrink the body. Declared on every operation that takes a request body. details carries exactly one key, maxBodyBytes (integer): the limit that applies to this surface, in bytes.
    ApiErrorResponse
  • 414
    VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge).Show moreVALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge). Not retryable as sent: send long input in the body of a POST.
    ApiErrorResponse
  • 415
    VALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes).Show moreVALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes). The public edge refuses it before the platform sees it (details.reason UNSUPPORTED_MEDIA_TYPE, details.source edge). Not retryable as sent: send Content-Type application/json. Declared on every operation that takes a JSON request body.
    ApiErrorResponse
  • 500INTERNAL — a bug, and traceId is the support handle.ApiErrorResponse

Errors you should handle

Branch on code and honour retryable — never on the HTTP status alone.

400VALIDATION
message.intent.checkOut must be after message.intent.checkIn
not retryable
400UNKNOWN_DOMAIN
Unknown domain 'HOTELS'. Did you mean HTL?
not retryable
401UNAUTHENTICATED
The bearer token is expired. Re-authenticate and retry.
not retryable
403PERMISSION_DENIED
Reading wallets needs the finance:read permission.
not retryable
405VALIDATION
This method is not served.
not retryable
409IDEMPOTENCY_CONFLICT
Idempotency-Key 7f0c33d1-9a1e-4d2c-9f77-1c0f2b3a4d55 was used with a different body; never executed
not retryable
409IDEMPOTENCY_IN_PROGRESS
A request with this Idempotency-Key is still executing
retryable
409CONFLICT
A confirmed registration changes only through POST /v1/activation/business-registration:confirm.
not retryable
413VALIDATION
The request body is larger than this API accepts (262144 bytes).
not retryable
414VALIDATION
The request URI is longer than 8 KiB.
not retryable
415VALIDATION
Send application/json.
not retryable
500INTERNAL
An unexpected error occurred. Quote the traceId to support.
retryable