Representatives

Update a representative

Changed on

Updates an existing representative's information. This can be used to update personal details, contact information, or the relationship to the account or organization.

put/v1/representatives/{representative_id}

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/representatives/{representative_id}
  • Auth
    HTTP bearer

Path parameters

representative_idstring uuid required

Headers

request-idstring

Optional client generated identifier to trace and debug a request.

correlation-idstring

Optional client generated identifier to trace and debug a series of requests.

idempotency-keystring

Optional client generated value to use for idempotent requests.

Request body

first_namestring required

The first name of the representative.

last_namestring required

The last name of the representative.

dobstring date required

The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).

ssn_last4string required

The last 4 digits of the representative's Social Security Number.

emailstring email required

The email address of the representative.

mobile_numberstring required

The mobile phone number of the representative.

external_idstring nullable

Unique identifier for the representative in your database, used for cross-referencing between Straddle and your systems.

metadataobject nullable

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the represetative in a structured format.

Example request

{
  "first_name": "Ron",
  "last_name": "Swanson",
  "dob": "1980-01-01",
  "ssn_last4": "1234",
  "email": "ron.swanson@pawnee.com",
  "mobile_number": "+12128675309"
}

Response

OK

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Example response

{
  "data": {
    "first_name": "Ron",
    "last_name": "Swanson",
    "dob": "1980-01-01",
    "ssn_last4": "1234",
    "email": "ron.swanson@pawnee.com",
    "mobile_number": "+12128675309"
  }
}

Changes

  • 8019e1d73575Revision changes
    • info

      added the new optional header request parameter idempotency-key

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)