Update HTTP request definition

Updates an existing HTTP request definition.

PUT /v1/http-request-definition/{definitionId}

JavaScript

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const httpRequestDefinition = await client.httpRequestDefinition.update('definitionId');

console.log(httpRequestDefinition.data);

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scope": "AGENT_OUTBOUND_DIAL",
    "description": "<string>",
    "url": "<string>",
    "method": "POST",
    "body": "<string>",
    "parsedBody": {},
    "headers": {},
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

definitionId · string · required

The ID of the HTTP request definition to update

Body

application/json

Input for updating an HTTP request definition

url · string<uri>

URL for the HTTP request

description · string | null

Description of the HTTP request definition

method · enum<string>

HTTP method: POST, PUT, PATCH, or GET

Available options: POST, PUT, PATCH, GET

body · string object

Request body template. Accepts a JSON object or a string with placeholders like {{phoneNumberToDial}}. Objects are serialized to JSON for storage.

headers · object

Request headers as key-value pairs

Show child attributes

Response

200

application/json

The updated HTTP request definition

data · object · required

HTTP request definition

Show child attributes