Update Onboarded Carrier

Update an onboarded carrier contact associated with the specific contact_id. This endpoint allows customers to update their own validated contact information.

Authentication

• Include your Access-Token in the header of your requests.

• Include your x-api-key The API key provided by GenLogs. This header must be included in the request.

Permissions

The external-api-update-onboarded-carrier-contact permission is required to access this endpoint.

Endpoint

• URL: https://api.genlogs.io/onboarded-carrier/contacts/{contact_id}

• Method: PATCH

Headers

• Access-Token: (string, required): Access token obtained from the "Create Access Token" endpoint.

• X-Api-Key (string, required): The API key provided by GenLogs.

Path Params

• contact_id (string, required): Existent contact ID, to de updated.

Request Body:

• name (string, optional): Contact name.

• phone (string, optional): Contact phone number

• email (string, optional): Contact email address.

Request Example:

curl --location --request PATCH 'http://localhost:9000/onboarded-carrier/contacts/ca387122-4153-418b-82df-03008cc9af9b' \
--header 'access-token: <your-api-key-token>' \
--header 'x-api-key: <your-x-api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "email": "peter_parker@test_email.com",
    "name": "Peter Parker",
    "phone": "3432434234"
}'

Response:

• 200 OK: A JSON object containing updated information of carrier contact.

• 400 Bad Request: If required parameters are missing or invalid.

• 401 Unauthorized: If the authentication credentials (Access-Token) is missing or incorrect.

• 403 Forbidden: If the permission has not been added to your user.

• 404 Not Found: If the provided contact_id doesn't exist or is not created.

• 500 Internal Server Error: If there is an issue on the server that prevents processing the request.

Response Body:

200 OK – Contact Created Successfully

{
  "contact": {
    "contact_id": "bd849e72-09f0-4d19-8b20-e227cd4ef455",
    "name": "Peter Parker",
    "phone": "3432434234",
    "email": "[email protected]"
  }
}

400 Bad Request

Returned when:

• All of name, phone, and email are null.

• All of name, phone, and email are empty strings.

• All the provided values are exactly the same as stored

{
    "detail": "Value error, at least one of name, email, or phone must be provided for update."
}

401 Unauthorized

• When access-token or

{
    "detail": "Token is missing!"
}

403 Forbidden

{
    "detail": "User not allowed to access this endpoint"
}

404 Not Found

{
    "detail": "Preferred carrier contact not found."
}

Update an onboarded carrier contact

patch

Updates an existing onboarded carrier contact for the authenticated customer. Requires a valid JWT token and the appropriate permission. Only the fields provided in the request body will be updated.

Authorizations

AccessTokenAuth & ApiKeyAuth

Access-TokenstringRequired

JWT provided directly in the Access-Token header. No "Bearer" prefix.

x-api-keystringRequired

API key provided by GenLogs.

Path parameters

contact_idstring · uuidRequired

Unique identifier of the contact to update.

Example: bd849e72-09f0-4d19-8b20-e227cd4ef455

Body

application/json

Fields to update. At least one must be provided.

namestring | nullableOptional

Contact name.

Example: Peter Parker

emailstring | nullableOptional

Contact email.

Example: [email protected]

phonestring | nullableOptional

Contact phone number.

Example: 3432434234

Responses

200

Contact updated successfully.

application/json

400

Bad Request – Missing or invalid fields.

application/json

401

Unauthorized – Invalid or missing Access-Token.

application/json

403

Forbidden – The user lacks required permission or does not own the contact.

application/json

404

Contact not found.

application/json

500

Internal Server Error.

application/json

patch

/onboarded-carrier/contacts/{contact_id}

HTTPcURLJavaScriptPython

PATCH /onboarded-carrier/contacts/{contact_id} HTTP/1.1
Host: api.genlogs.io
Access-Token: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "Peter Parker",
  "email": "[email protected]",
  "phone": "3432434234"
}

{
  "contact": {
    "id": "bd849e72-09f0-4d19-8b20-e227cd4ef455",
    "name": "Peter Parker",
    "phone": "3432434234",
    "email": "[email protected]"
  }
}