/api/v1/claim-packs

POST

/api/v1/claim-packs

const url = 'https://example.com/api/v1/claim-packs';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"scope":{"incidentId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"},"locale":"en","digits":"western","acknowledged":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/claim-packs \
  --header 'Content-Type: application/json' \
  --data '{ "scope": { "incidentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "locale": "en", "digits": "western", "acknowledged": true }'

Request Body^required

application/json

object

scope

required

Any of:

object
object

object

incidentId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

locale

string

Allowed values: en ar fr de it

digits

string

Allowed values: western eastern

acknowledged

boolean

Responses

202

Default Response

application/json

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

status

required

string

Allowed values: queued

Example

{
  "status": "queued"
}

/api/v1/claim-packs

Request Bodyrequired

Responses

202

Example

Request Body^required