Update the organization's settings

PUT

/api/organizations/settings

curl --request PUT \
  --url https://example.com/api/organizations/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Community Food Pantry", "slug": "hope-community-center", "shortCode": "DCC", "maxConcurrency": 5, "tcrStatus": "APPROVED" }'

Authorizations

• BearerAuth

Request Body^required

Media typeapplication/json

object

name

required

Full display name of the resource, facility, or individual.

string

Example

Community Food Pantry

slug

required

URL-friendly unique slug identifier.

string

Example

hope-community-center

shortCode

Unique 4 to 6 character uppercase short code.

string

Example

DCC

maxConcurrency

Maximum allowed concurrent SMS messaging connections.

integer

Example

5

tcrStatus

The Campaign Registry (TCR) 10DLC registration status.

string

Example

APPROVED

Responses

200

Organization settings updated successfully

Media typeapplication/json

object

id

required

Unique identifier (UUID v4) for the resource.

string format: uuid

name

required

Full display name of the resource, facility, or individual.

string

slug

required

URL-friendly unique slug identifier.

string

shortCode

Unique 4 to 6 character uppercase short code.

string

maxConcurrency

Maximum allowed concurrent SMS messaging connections.

integer

tcrStatus

The Campaign Registry (TCR) 10DLC registration status.

string

phoneNumber

Provisioned system phone number.

string

Example

{
  "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "name": "Community Food Pantry",
  "slug": "hope-community-center",
  "shortCode": "DCC",
  "maxConcurrency": 5,
  "tcrStatus": "APPROVED",
  "phoneNumber": "+17045550100"
}

400

Invalid request

401

Unauthorized

403

Forbidden