/api/v1/outbound/carrier-accounts/{carrierAccountId} (PUT)

PUT

/api/v1/outbound/carrier-accounts/{carrierAccountId}

curl --request PUT \
  --url https://example.com/api/v1/outbound/carrier-accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "provider": "Simulated", "apiKey": "example", "isDefault": true }'

Authorizations

• Bearer

Parameters

Path Parameters

carrierAccountId

required

string format: uuid

Request Body^required

object

name

string

provider

string

nullable

Allowed values: Simulated EasyPost

apiKey

string

nullable

isDefault

boolean

object

name

string

provider

string

nullable

Allowed values: Simulated EasyPost

apiKey

string

nullable

isDefault

boolean

object

name

string

provider

string

nullable

Allowed values: Simulated EasyPost

apiKey

string

nullable

isDefault

boolean

Responses

200

OK

object

id

required

string format: uuid

name

required

string

provider

required

string

Allowed values: Simulated EasyPost

isDefault

required

boolean

hasApiKey

required

boolean

apiKeyLast4

required

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

object

id

required

string format: uuid

name

required

string

provider

required

string

Allowed values: Simulated EasyPost

isDefault

required

boolean

hasApiKey

required

boolean

apiKeyLast4

required

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "provider": "Simulated"
}

object

id

required

string format: uuid

name

required

string

provider

required

string

Allowed values: Simulated EasyPost

isDefault

required

boolean

hasApiKey

required

boolean

apiKeyLast4

required

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "provider": "Simulated"
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}