---
title: "Update Challenge Profile"
method: POST
path: "/pws/pws_update_challenge_profile/"
tags: ["Apata"]
---

# Update Challenge Profile

`POST /pws/pws_update_challenge_profile/`

This API provides the ability to update challenge profile.It's a Pass through API that internally calls Apata API

## Request body

- UpdateChallengeProfileModel
  - `api_call_unique_identifier` string, required — Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required — Unique identifier for the client which Paymentology will provide at outset
  - `id` string, required — Unique identifier for the challenge profile.
  - `user_id` string — User Id of the Customer who triggered the API request.
  - `remarks` string — Remarks for API request
  - `name` string — Display name for the Challenge Profile.
  - `description` string — Optional description for the Challenge Profile.
  - `properties` ChallengeProfilePropertiesModel — Options that configure challenge profile.
    - `allow_choice` boolean, required — If set to true presents cardholder with choice screen.
    - `allow_choice_on_fallback` boolean, required — If set to true will automatically fall back to next challenge methods in the event that an error occurs during the creation of the challenge .
    - `allow_fallback` boolean, required — If set to true allows cardhodler be presented with the choice screen again.
    - `challenge_interface_id` string — Unique identifier for the challenge interface.
    - `options` ChallengeProfileOptionModel[]
      - `alias` string, required — A unique, human-readable reference for a challenge profile option.
      - `challenge_method_ids` string[], required — An array of challenge method ids that can be used in an option.
      - `fallback_on_error` boolean, required — Will automatically fall back in the event that an error occurs during the creation of the challenge.
      - `choice_index` integer — Indicates an order of choice.
      - `fallback_index` integer — Indicates an order in which fallback happens.

## Response `200`

Successful Response

- UpdateChallengeProfileResponseModel
  - `header` Header
    - `error_desc` string, required — Error Description
    - `error_id` integer, required — Error Id
  - `body` UpdateChallengeProfileResponse
    - `id` string — Unique identifier for the challenge profile.
    - `name` string — Display name for the Challenge Profile.
    - `description` string — Optional description for the Challenge Profile.
    - `type` string — The type of Challenge Profile.
    - `alias` string — A unique, human-readable reference for a challenge profile.
    - `properties` UpdateChallengeProfileResponseModelProperties — UpdateChallengeProfileResponseModel Properties
      - `choiceChallengeInterfaceId` string — Unique identifier for the challenge interface.
      - `allowFallback` boolean — If set to true allows cardhodler be presented with the choice screen again.
      - `allowChoice` boolean — If set to true presents cardholder with choice screen.
      - `allowChoiceOnFallback` boolean — If set to true will automatically fall back to next challenge methods in the event that an error occurs during the creation of the challenge .
      - `options` Option[]
        - `alias` string — A unique, human-readable reference for a challenge profile option.
        - `choiceIndex` integer — Indicates an order of choice.
        - `fallbackIndex` integer — Indicates an order in which fallback happens.
        - `fallbackOnError` boolean — Will automatically fall back in the event that an error occurs during the creation of the challenge.
        - `challengeMethodIds` string[] — An array of challenge method ids that can be used in an option.
    - `created` string — The date-time the challenge profile was created.
    - `updated` string — The date-time the challenge profile was updated.

## Other responses

- `404` — Webservices does not exist
- `500` — Internal Server error

---

[API](https://skmtc.net/paymentology/apis/payapi-docs.md) · [All operations](https://skmtc.net/paymentology/apis/payapi-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paymentology/payapi-docs/revisions/a675891b0365/schema)